gridhead / mdapi Goto Github PK

Inspirations can be taken from here https://pagure.io/mdapi/blob/master/f/Dockerfile

Add software licensing

"GPL-3.0-or-later" is compatible with a "GPL-2.0-or-later" code, so front porting the license seems like the right choice here.

Document testing of the mdapi project

We definitely would not want to ship a vulnerable code now, would we?

After the reworking of the GitHub Actions config (here), the tests which involve downloading the database files get skipped (as evidenced here).

This is strange and inconsistent, as all occurrences of the tests involving downloading the database files used to work except the first one per job used in the previous test configuration (here). For example,

1. In this job on Python 3.8 (here), the first (and the only) occurrence (using Python 3.8) of the testcase involving downloading the database files gets skipped (as evidenced here).
2. In this job on Python 3.9 (here), the first occurrence (using Python 3.8) gets skipped (as evidenced here) but the second occurrence (using Python 3.9) works (as evidenced here).
3. In this job on Python 3.10 (here), the first occurrence (using Python 3.8) gets skipped (as evidenced here) but the second occurrence (using Python 3.10) works (as evidenced here).

Should have URL structures and endpoints to begin with.

We need entire run test cases as well as function-based test cases for the database fetching code.

Many automated dependency updates from https://github.com/dependabot are failing and certain versions of certain dependencies are either not available or are not compatible with other dependencies.

Pull requests affected by this

1. #78
2. #79
3. #80

For now, the workaround employed is ignoring those PRs for now and coming back to them when new PRs for the same dependencies are created for the newer versions. If they pass the CI, the problem would automatically be solved but if not, the dependency lockfile needs to be investigated.

Write unit tests for the code

Restructure the default configuration as a YAML file

While building the container image, it should also include the certificates required for publishing information on the messaging bus.

Ref. https://github.com/fedora-infra/mote/blob/main/Dockerfile#L11-#L14

Tests that result in expected errors and tests that involve going through the configuration files are needed. If folks want to add more tests atop them, that would be even better.

Set up structure for the Python project

SQLAlchemy is to be used to do so.

The existing code can be found here https://pagure.io/mdapi/blob/master/f/mdapi-get_repo_md.

Add some tests for checking the database fetching functionality

Ensure that the code formatting works with GitHub CI

Inspirations can be taken from here https://pagure.io/mdapi/blob/master/f/mdapi.service

Set up the index page for the root endpoint

Rework .gitignore file to accommodate project structure change

We would not want to ship a vulnerable code now, would we?

Certain things like which lines to check and which lines to avoid as well as which directories to run these tests in should be present in the .coveragerc file.

In the spirit of getting more contributors to the project, the above document would be appreciated.

Set up the project documentation

We would want to know how much part of the code is tested.

In the spirit of getting more contributors to the project, the above document would be appreciated.

Restructure web application service source code

Include code format and linting checks for now

@Zlopez reported that when he ran mdapi --version command, he faced the following error.

   Traceback (most recent call last):
    File "/var/home/zlopez/git/mdapi/venv/bin/mdapi", line 2, in <module>
      from mdapi.main import main
    File "/var/home/zlopez/git/mdapi/mdapi/main.py", line 30, in <module>
      from mdapi.database.main import index_repositories
    File "/var/home/zlopez/git/mdapi/mdapi/database/main.py", line 36, in <module>
      from fedora_messaging.api import publish
    File "/var/home/zlopez/git/mdapi/venv/lib/python3.10/site-packages/fedora_messaging/api.py", line 10, in <module>
      from . import config, exceptions
    File "/var/home/zlopez/git/mdapi/venv/lib/python3.10/site-packages/fedora_messaging/config.py", line 287, in <module>
      import pkg_resources
  ModuleNotFoundError: No module named 'pkg_resources'

This usually happens when setuptools dependency is not installed or present in the project and hence, it necessitates its addition in the dependency list.

Helps avoid vulnerabilities could be potentially brought about by older releases of the dependencies.