Add OpenAPI sample generation.

Signed-off-by: Caroline Russell <caroline@appthreat.dev>

.github/workflows/generate_samples.yml

@@ -130,12 +130,19 @@ jobs:
       - name: Setup Node.js environment
         uses: actions/setup-node@v4.0.1
         with:
-          node-version: 20
+          node-version: 21
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
 
       -  name: Atom, cdxgen, sdkman installs
          run: |
            npm install -g @cyclonedx/cdxgen
            npm install -g @appthreat/atom
+           python -m pip install --upgrade pip
+           python -m pip install atom-tools
            curl -s "https://get.sdkman.io" | bash
            source "/home/runner/.sdkman/bin/sdkman-init.sh"
 

generate.py

@@ -180,6 +180,7 @@ def exec_on_repo(clone, output_dir, skip_build, slice_types, repo):
     lang = repo['language']
     loc = Path.cwd()
     repo_dir = repo['repo_dir']
+    gen_api = repo['gen_api']
     commands = ''
 
     if clone:
@@ -204,12 +205,26 @@ def exec_on_repo(clone, output_dir, skip_build, slice_types, repo):
     for stype in slice_types:
         slice_file = Path.joinpath(output_dir, lang, f'{project}-{stype}.json')
         atom_file = Path.joinpath(repo_dir, f'{project}.atom')
-        cmd = ['atom', stype, '-l', lang, '-o', atom_file, '-s', slice_file, repo_dir]
+        if stype == 'usages' and gen_api:
+            commands += generate_openapi(project, output_dir, lang, slice_file, atom_file, repo_dir)
+            continue
+        cmd = ['atom', stype,'-l', lang, '-o', atom_file, '-s', slice_file, repo_dir]
         commands += f'\n{subprocess.list2cmdline(cmd)}'
     commands += '\n\n'
     return commands
 
 
+def generate_openapi(project, output_dir, lang, slice_file, atom_file, repo_dir):
+    cmds = ''
+    cmd = ['atom', 'usages', '--extract-endpoints', '-l', lang, '-o', atom_file, '-s', slice_file,
+           repo_dir]
+    cmds += f'\n{subprocess.list2cmdline(cmd)}'
+    openapi_file = Path.joinpath(repo_dir, 'openapi.generated.json')
+    cmd = ['mv', openapi_file, Path.joinpath(output_dir, lang, f'{project}_openapi.json')]
+    cmds += f'\n{subprocess.list2cmdline(cmd)}'
+    return cmds
+
+
 def read_csv(csv_file, langs, projects, clone_dir):
     """
     Reads a CSV file and filters the data based on a list of languages.

sources.csv

@@ -1,12 +1,17 @@
-project,link,language,pre_build_cmd,build_cmd
-"apollo","https://github.com/apolloconfig/apollo.git","java","sdk use maven 3.5.4;sdk use java 17.0.9-zulu","mvn -B clean compile -Dmaven.gitcommitid.skip=true -DskipTests=true"
-"karate","https://github.com/karatelabs/karate.git","java","sdk use java 21.ea.35-open","mvn -B clean install -P pre-release -pl '!karate-gatling' -Djavacpp.platform=linux-x86_64 -DskipTests=true"
-"piggymetrics","https://github.com/sqshq/piggymetrics.git","java","sdk use java 8.0.392-zulu","mvn -B -ntp package -DskipTests=true"
-"axios","https://github.com/axios/axios.git","javascript","",""
-"videojs","https://github.com/videojs/video.js.git","javascript","",""
-"sequelize","https://github.com/sequelize/sequelize.git","javascript","","yarn install"
-"ava","https://github.com/avajs/ava.git","javascript","","npm install"
-"spaCy","https://github.com/explosion/spaCy.git","python","",""
-"scrapy","https://github.com/scrapy/scrapy.git","python","","python -m venv venv; source venv/bin/activate && pip install ."
-"tinydb","https://github.com/msiemens/tinydb.git","python","","python -m venv venv; source venv/bin/activate && pip install ."
-"tornado","https://github.com/tornadoweb/tornado.git","python","","python -m venv venv; source venv/bin/activate && pip install ."
+project,link,language,pre_build_cmd,build_cmd,gen_api
+"apollo","https://github.com/apolloconfig/apollo.git","java","sdk use maven 3.5.4;sdk use java 17.0.9-zulu","mvn -B clean compile -Dmaven.gitcommitid.skip=true -DskipTests=true",""
+"java-sec-code","https://github.com/JoyChou93/java-sec-code.git","java","sdk use java 8.0.392-zulu","mvn -B clean compile -DskipTests=true",1
+"karate","https://github.com/karatelabs/karate.git","java","sdk use java 21.ea.35-open","mvn -B clean install -P pre-release -pl '!karate-gatling' -Djavacpp.platform=linux-x86_64 -DskipTests=true",""
+"piggymetrics","https://github.com/sqshq/piggymetrics.git","java","sdk use java 8.0.392-zulu","mvn -B -ntp package -DskipTests=true",1
+"axios","https://github.com/axios/axios.git","javascript","","",""
+"juiceshop","https://github.com/juice-shop/juice-shop.git","javascript","","npm install",1
+"node-goat","https://github.com/OWASP/NodeGoat.git","javascript","","npm install",1
+"sequelize","https://github.com/sequelize/sequelize.git","javascript","","yarn install",""
+"videojs","https://github.com/videojs/video.js.git","javascript","","",""
+"ava","https://github.com/avajs/ava.git","javascript","","npm install",""
+"breakable-flask","https://github.com/stephenbradshaw/breakableflask.git","python","","python -m venv venv; source venv/bin/activate && pip install -r requirements.txt",1
+"django-goat","https://github.com/red-and-black/DjangoGoat.git","python","","python -m venv venv; source venv/bin/activate && pip install -r requirements_app.txt",1
+"spaCy","https://github.com/explosion/spaCy.git","python","","",""
+"scrapy","https://github.com/scrapy/scrapy.git","python","","python -m venv venv; source venv/bin/activate && pip install .",""
+"tinydb","https://github.com/msiemens/tinydb.git","python","","python -m venv venv; source venv/bin/activate && pip install .",""
+"tornado","https://github.com/tornadoweb/tornado.git","python","","python -m venv venv; source venv/bin/activate && pip install .",""