ci: Validation of OpenAPI files using GitHub Actions

[teolemon]

• Installs Python, dependancies, a PostGre instance
• Find out how to generate the OpenAPI file from the source code
• Runs the Test Suite (tests are failing, probably because of bad config of the postgre instance)
• Validation of OpenAPI files using GitHub Actions
• EXTRA: find out how to generate SDKs from the source code

What db name, user and pass should I use ? Any tip to make the tests green ?

[cquest]

Documentation and the openapi file are generated live by the API itself.

https://api.folksonomy.openfoodfacts.org/openapi.json

[teolemon]

Is there a FASTAPI option or plugin to generate it in command line for Continuous Integration purposes or other things ?

[teolemon]

Eg:

• to check a proposed PR for certain things
• to generate SDKs and publish them on repositories
• …

[cquest]

See: https://github.com/openfoodfacts/folksonomy_api/blob/main/generate_openapi_json.py

It calls fastapi and generates the openapi.json on stdout.

[teolemon]

======================
= Linting OAS file =

OpenAPI 3.x detected

/github/workspace/openapi.json
1:1 warning oas3-api-servers OpenAPI servers must be present and non-empty array.
1:1 warning openapi-tags OpenAPI object should have non-empty tags array.
1:29 warning info-contact Info object should contain contact object. info
1:29 warning info-description OpenAPI object info description must be present and non-empty string. info
1:122 warning operation-description Operation description must be present and non-empty string. paths./.get
1:122 warning operation-tags Operation should have non-empty tags array. paths./.get
1:303 warning operation-tags Operation should have non-empty tags array. paths./auth.post
1:1125 warning operation-tags Operation should have non-empty tags array. paths./products.get
1:2063 warning operation-tags Operation should have non-empty tags array. paths./product/{product}.get
1:2895 warning operation-tags Operation should have non-empty tags array. paths./product/{product}/{k}.get
1:3686 warning operation-tags Operation should have non-empty tags array. paths./product/{product}/{k}.delete
1:4581 warning operation-tags Operation should have non-empty tags array. paths./product/{product}/{k}/versions.get
1:5580 warning operation-tags Operation should have non-empty tags array. paths./product/{product}/{k}/version/{version}.get
1:6534 warning operation-tags Operation should have non-empty tags array. paths./product.put
1:7317 warning operation-tags Operation should have non-empty tags array. paths./product.post
1:7892 warning operation-tags Operation should have non-empty tags array. paths./keys.get
1:8507 warning operation-tags Operation should have non-empty tags array. paths./ping.get

✖ 17 problems (0 errors, 17 warnings, 0 infos, 0 hints)

[teolemon]

E psycopg2.OperationalError: could not connect to server: No such file or directory
E Is the server running locally and accepting
E connections on Unix domain socket "/var/run/postgresql/.s.PGSQL.5432"?

[teolemon]

I managed to populate and connect to the db
Half of the tests are passing

=========================== short test summary info ============================
FAILED tests/test_main.py::test_product - TypeError: 'NoneType' object is not...
FAILED tests/test_main.py::test_product_key - TypeError: 'NoneType' object is...
FAILED tests/test_main.py::test_product_key_missing - TypeError: 'NoneType' o...
FAILED tests/test_main.py::test_product_key_versions - TypeError: 'NoneType' ...
FAILED tests/test_main.py::test_product_key_last_version - TypeError: 'NoneTy...
FAILED tests/test_main.py::test_product_key_first_version - TypeError: 'NoneT...
FAILED tests/test_main.py::test_product_key_versions_missing - TypeError: 'No...
FAILED tests/test_main.py::test_products_list_key_value - TypeError: 'NoneTyp...
FAILED tests/test_main.py::test_products_list_key - TypeError: 'NoneType' obj...
========================= 9 failed, 8 passed in 6.24s ==========================