Add a formatted representation of the UpdatePageAction dataclass

mthaddon commented 8 months ago

Applicable spec: N/A

Overview

Add a formatted representation of the UpdatePageAction dataclass.

Rationale

This relates to https://github.com/canonical/discourse-gatekeeper/issues/226. I've started by only adding for one dataclass to get some feedback on the approach before I apply it more widely.

Module Changes

N/A

Checklist

[x] The contributing guide was applied
[x] The documentation is generated using src-docs
[x] The PR is tagged with appropriate label (urgent, trivial, complex)
[x] Changelog has been updated
[ ] Version has been incremented

Haven't incremented the version as I'm not sure if that's appropriate.

jdkandersson commented 8 months ago

I think main can be merged in now which should address some of the failing checks

mthaddon commented 8 months ago

I think main can be merged in now which should address some of the failing checks

$ git merge main
Already up to date.

I'll rerun the checks.

jdkandersson commented 8 months ago

The issues are:

Black formatting doesn't seem to be applied
The integration tests look for the name of the action in the log messages which used to be UpdateAction(...) or similar. Perhaps in the string representation include the action being taken? You can check the integration test for more details, please let me know if you need more help. It is case sensitive at the moment

github-actions[bot] commented 8 months ago

Test coverage for e99b37761ae3a9c36387833055ae48b72d666a6d

Name                      Stmts   Miss Branch BrPart  Cover   Missing
---------------------------------------------------------------------
src/__init__.py              97      0     42      0   100%
src/action.py               155      0     46      0   100%
src/check.py                 67      0     27      0   100%
src/clients.py               12      0      0      0   100%
src/commit.py                42      0     12      0   100%
src/constants.py             10      0      0      0   100%
src/content.py               50      0     10      0   100%
src/discourse.py            159      0     34      0   100%
src/docs_directory.py        33      0      8      0   100%
src/download.py              23      0      2      0   100%
src/exceptions.py            15      0      0      0   100%
src/index.py                142      0     56      0   100%
src/metadata.py              28      0     12      0   100%
src/migration.py            102      0     33      0   100%
src/navigation_table.py      65      0     20      0   100%
src/reconcile.py            123      0     60      0   100%
src/repository.py           284      0     88      0   100%
src/sort.py                  43      0     26      0   100%
src/types_.py               201      0     54      0   100%
---------------------------------------------------------------------
TOTAL                      1651      0    530      0   100%

Static code analysis report

Working... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:01
Run started:2024-01-25 04:42:41.052487

Test results:
    No issues identified.

Code scanned:
    Total lines of code: 17621
    Total lines skipped (#nosec): 3
    Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
    Total issues (by severity):
        Undefined: 0
        Low: 0
        Medium: 0
        High: 0
    Total issues (by confidence):
        Undefined: 0
        Low: 0
        Medium: 0
        High: 0
Files skipped (0):

canonical / discourse-gatekeeper