vaderz / agnostic-report Goto Github PK

Add authentication for:

• for Web UI, likely JWT with scopes (at least "admin" and "user")
• for API users (Basic or API Key)

Move agnostic.core.schemas to a separate package to share it with agnostic.pytest. It doesn't make much sense to use OpenAPI generator for the plugin as it would be really tricky to use generated services and proper models are already available in core

Allow importing xUnit XML into existing projects. Consider the following while implementing:

• does it make sense to support v1 format or v2 will be enough?
• should one send test run properties in a report upload request, or they have to be specified as XML attributes, or support both options?
• should this be an async task or sync if fine?
• should original XML be preserved?

There multiple issues that have to be addressed in Web UI:

• upgrade to the latest version of Vuestic UI
• remove leftovers of Vuestic Admin template
• use generated OpenAPI client instead of raw axios, group everything under services namespace to follow VueJS conventions
• clearly separate components from pages/views, use smaller components (e.g. test view component have to be broken down into separate parts)
• use global events for refreshes instead of local timers in every component
• state storage usage is quite messy, see if this can be cleaned up
• integrate authentication (requires at least user management page)

Size of agnostic-core.dal.reporting has got out of control, split into small and format properly

While working on #6 it turned out that hierarchical API doesn't make much sense and only adds complexity both on server side (makes hard to share data access code) and client side (client has to carry a lot of context even if in fact not needed), so it would be better to switch to a flat structure and implement it as v2 API. This will also help to integrate auth #8 without immediately breaking the UI.

API v2 should follow the following principals:

• only one level of hierarchy, filtering instead of nesting, e.g.
  /tests
/tests/{test_id}
/tests?test-run-id={test_run_id}
/metrics?test_id={test_id}

• RPC-like "actions" are still allowed
  POST /test/{test_id}/finish
  -no redundant id's in request body, e.g. this should go away

      PUT /projects/{project_id}/test-runs/{test_run_id}/tests/{test_id}
      {
         "project_id": ...,
         "test_run_id": ...,
         "test_id": ...,
       }
  

  in this case only an id of an immediate parent (test_run_id) should be a part of the body

• all "plurals" should support paging by default with page_size and page arguments, sending back X-Total-Count header along with the response

The following needs to be revised:

• service and methods names, currently they are autogenerated and look really messy in a generated client
• double check if model fields have proper constraints everywhere

Add code linter and/or code formatter for Python. Black, YAPF?