Merge pull request #29 from fopina/minor

integration tests and other minor tweaks

Author: fopina

.github/workflows/test.yml

@@ -79,6 +79,6 @@ jobs:
           pipenv requirements --dev > reqs.txt
           pip install -r reqs.txt
 
-      - name: Run unit tests
+      - name: Run e2e tests
         run: |
-          python example.py
+          make test-e2e

.openapi-generator-ignore

@@ -0,0 +1,24 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
+*README.md

.openapi-generator/FILES

@@ -0,0 +1 @@
+7.13.0

.openapi-generator/VERSION

@@ -15,15 +15,21 @@ test:
 		python -m pytest --cov; \
 	fi
 
+test-e2e: export DD_INTEGRATION_TESTS=1
+test-e2e:
+	python -m pytest tests/integration
+
 testpub:
 	rm -fr dist
 	pyproject-build
 	twine upload --repository testpypi dist/*
 
 schema:
-	curl "https://demo.defectdojo.org/api/v2/oa3/schema/?format=json" -o support/openapi.json
+	./support/fetch_openapi.py
 
-generate:
+templates:
 	./support/api_generation/dump_templates.sh
+
+generate:
 	./support/api_generation/generate.sh
 	$(MAKE) lint

Makefile

@@ -51,7 +51,7 @@ line-ending = "auto"
 
 [tool.pytest.ini_options]
 minversion = "6.0"
-addopts = "-ra -q --disable-socket"
+addopts = "-ra -q --disable-socket --allow-hosts=127.0.0.1"
 testpaths = [
     "tests",
 ]

pyproject.toml

@@ -1,7 +1,13 @@
-templateDir: local/support/api_generation/templates.spec
+generatorName: python
+templateDir: support/api_generation/custom_templates
 additionalProperties:
   generateSourceCodeOnly: true
   packageName: defectdojo_api_generated
+  packageUrl: https://github.com/fopina/defectdojo-api-generated
+  projectName: defectdojo-api-generated
+globalProperties:
+  modelDocs: false
+  apiDocs: false
 files:
   client.mustache:
     folder: defectdojo_api_generated

support/api_generation/config.yaml

@@ -0,0 +1,60 @@
+# {{{projectName}}}
+{{#appDescriptionWithNewLines}}
+{{{.}}}
+{{/appDescriptionWithNewLines}}
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: {{appVersion}}
+- Package version: {{packageVersion}}
+{{^hideGenerationTimestamp}}
+- Build date: {{generatedDate}}
+{{/hideGenerationTimestamp}}
+- Generator version: {{generatorVersion}}
+- Build package: {{generatorClass}}
+{{#infoUrl}}
+For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
+{{/infoUrl}}
+
+## Requirements.
+
+Python {{{generatorLanguageVersion}}}
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git`)
+
+Then import the package:
+```python
+import {{{packageName}}}
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import {{{packageName}}}
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+{{> common_README }}

support/api_generation/custom_templates/README.mustache

@@ -0,0 +1,50 @@
+# {{{projectName}}}
+{{#appDescription}}
+{{{.}}}
+{{/appDescription}}
+
+The `{{packageName}}` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: {{appVersion}}
+- Package version: {{packageVersion}}
+{{^hideGenerationTimestamp}}
+- Build date: {{generatedDate}}
+{{/hideGenerationTimestamp}}
+- Generator version: {{generatorVersion}}
+- Build package: {{generatorClass}}
+{{#infoUrl}}
+For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
+{{/infoUrl}}
+
+## Requirements.
+
+Python {{{generatorLanguageVersion}}}
+
+## Installation & Usage
+
+This python library package is generated without supporting files like setup.py or requirements files
+
+To be able to use it, you will need these dependencies in your own package that uses this library:
+
+* urllib3 >= 2.1.0, < 3.0.0
+* python-dateutil >= 2.8.2
+{{#asyncio}}
+* aiohttp >= 3.8.4
+* aiohttp-retry >= 2.8.3
+{{/asyncio}}
+{{#tornado}}
+* tornado >= 4.2, < 5
+{{/tornado}}
+{{#hasHttpSignatureMethods}}
+* pem >= 19.3.0
+* pycryptodome >= 3.9.0
+{{/hasHttpSignatureMethods}}
+* pydantic >= 2
+* typing-extensions >= 4.7.1
+
+## Getting Started
+
+In your own code, to use this library to connect and interact with {{{projectName}}},
+you can run the following:
+
+{{> common_README }}