Combined workspace audits #778

amstilp · 2024-10-15T18:36:07Z

Add audit classes for ConsortiumCombinedDataWorkspaces
Add views for auditing combined workspaces
Rework audit classes such that they are shared between audits for different workspace types
Move audit handling methods out of the views and into the audit result classes themselves
Add view mixins for audit and audit resolve views
Add a management command for running a combined workspace audit

We can reuse the audit results classes for audits of other workspace types in the future. Split them into their own source file.

Because these audit result classes are intended to be used for multiple differnet types of workspace auditing, we shouldn't set the class of the "workspace" field to UploadWorkspace. Change it, and also update the tests and templates where necessary.

Because we moved the audit results classes to their own source files, it is much less cluttered to have both upload workspace audits together. It also makes sense in a way, because they work together (both audits should be run at the same time).

Add a specific template for this action button, and then use that action button in the table. (Previously it was using the upload workspace audit template because this one didn't exist yet.)

Also add templates, which will likely be updated as the views are actually written.

The view was accidentally pointing the upload workspace sharing audit template.

…space

It should be ChangeToAdmin, not AddMember. Fix the audit and tests.

I had added this test to a different TestCase thinking it had been missed earlier, but I was incorrect - the test in question is not needed in the TestCase, and already exists where it is needed.

Also rename the file to have a more descriptive name - it's not just upload workspaces anymore.

For both the Combined workspace sharing audit and the upload workspace sharing audit. Green/black or green/red imply errors vs correctness, but black does not.

Make it clear that the buttons are for auditing upload workspaces, not the combined workspace.

This mixin defines a method to run an audit, and then adds the results of that audit to the context. Use the new mixin in the views. Note that we aren't using the mixin in the audit resolve method, because it doesn't run audits in the same way.

Instead of having the logic in the view, move it into the audit result classes themselves. This makes it so the view only has to handle exceptions instead of logic.

Use the new mixin in the existing views.

codecov · 2024-10-15T18:47:03Z

Codecov Report

Attention: Patch coverage is 99.48718% with 7 lines in your changes missing coverage. Please review.

Project coverage is 98.53%. Comparing base (45635a5) to head (475245d).
Report is 109 commits behind head on main.

Files with missing lines	Patch %	Lines
...jango/gregor_anvil/audit/upload_workspace_audit.py	99.47%	2 Missing ⚠️
gregor_django/gregor_anvil/viewmixins.py	96.42%	2 Missing ⚠️
...anvil/audit/workspace_auth_domain_audit_results.py	98.85%	1 Missing ⚠️
...gor_anvil/audit/workspace_sharing_audit_results.py	99.00%	1 Missing ⚠️
gregor_django/gregor_anvil/tests/factories.py	85.71%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #778      +/-   ##
==========================================
+ Coverage   97.95%   98.53%   +0.58%     
==========================================
  Files         149      162      +13     
  Lines       16040    20503    +4463     
==========================================
+ Hits        15712    20203    +4491     
+ Misses        328      300      -28

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Handled in main branch, but I want CI to run in this branch.

amstilp added 24 commits September 5, 2024 15:51

Start splitting audit results into their own source files

e8c7775

We can reuse the audit results classes for audits of other workspace types in the future. Split them into their own source file.

Add auditing for combined workspace sharing

12782c6

Add auditing classes for combined workspace auth domains

cb9ecaa

Automatically create an auth domain in the combined workspace factory

d1baf8d

Add views to audit sharing for combined workspaces

c2f18d6

Add a view to resolve CombinedConsortiumDataWorkspace sharing audits

8289314

Update the action button for combined workspace sharing audit

ecc4dec

Add a specific template for this action button, and then use that action button in the table. (Previously it was using the upload workspace audit template because this one didn't exist yet.)

Add skeleton views for auth domain auditing

70db266

Also add templates, which will likely be updated as the views are actually written.

Fix template for combined workspace sharing audit

83358d5

The view was accidentally pointing the upload workspace sharing audit template.

Add view to audit auth domain membership for all combined workspaces

872b187

Add a view to audit auth domain membership for a single combined work…

5475f65

…space

Change audit class when DCC admins is a member

19bc38d

It should be ChangeToAdmin, not AddMember. Fix the audit and tests.

Add view to resolve auth domain audits for combined workspaces

6808d64

Remove accidentally-added test

de6f45c

I had added this test to a different TestCase thinking it had been missed earlier, but I was incorrect - the test in question is not needed in the TestCase, and already exists where it is needed.

Start updating test data script for combined workspace auditing

445a39d

Also rename the file to have a more descriptive name - it's not just upload workspaces anymore.

Update test data for combined workspace auditing

d23137e

Make can_compute icons black in tables

7274f54

For both the Combined workspace sharing audit and the upload workspace sharing audit. Green/black or green/red imply errors vs correctness, but black does not.

Add links to audit views on combined workspace detail page

f488b15

Update wording on upload cycle detail audit buttons

fe2bc68

Make it clear that the buttons are for auditing upload workspaces, not the combined workspace.

Add (and use) a mixin for running audits

501cd1c

This mixin defines a method to run an audit, and then adds the results of that audit to the context. Use the new mixin in the views. Note that we aren't using the mixin in the audit resolve method, because it doesn't run audits in the same way.

Move code to handle audit results into the result subclasses

bcb60fe

Instead of having the logic in the view, move it into the audit result classes themselves. This makes it so the view only has to handle exceptions instead of logic.

Add a view mixin for audit resolve views

23ff9b2

Use the new mixin in the existing views.

amstilp added 5 commits October 16, 2024 13:36

Add a management command to audit combined workspaces

5633de6

Clean up test coverage

ca9a0fb

Bump gitleaks version

13fa73b

Handled in main branch, but I want CI to run in this branch.

Add nightly combined workspace audit to cron file

5422e5f

Clean up audit templates for consistency

475245d

amstilp merged commit e50af32 into main Oct 23, 2024
10 checks passed

amstilp deleted the feature/combined-workspace-audits branch October 23, 2024 18:13

amstilp mentioned this pull request Oct 23, 2024

Add auditing for Combined consortium data workspaces #734

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Combined workspace audits #778

Combined workspace audits #778

amstilp commented Oct 15, 2024

codecov bot commented Oct 15, 2024 •

edited

Loading

Combined workspace audits #778

Combined workspace audits #778

Conversation

amstilp commented Oct 15, 2024

codecov bot commented Oct 15, 2024 • edited Loading

Codecov Report

codecov bot commented Oct 15, 2024 •

edited

Loading