Write unit test suite #170

Joe-Heffer-Shef · 2025-03-14T11:21:18Z

Changes:

Add tests to GitHub Actions workflow
Refactor test suite
Add unittest.TestCase base classes for views and services
Implement mock object factories using Factory Boy
Added unit tests for:
- Organisation Service
- Organisation views
- Project Service
- Project views
- User views (home, login, logout)
- Survey service
Added coverage report
Run tests in parallel (2 cores on a GHA runner)

The invite tests are currently disabled.

twinkarma

Thanks @Joe-Heffer-Shef, I've also added all the base permission tests which has now been merged into the dev branch. Also added factoryboy for creating test objects. Can you integrate them into this PR?

twinkarma · 2025-03-14T11:40:57Z

Also let's use the dev branch as the as the one we just for active development. Once we're happy with the state of the dev branch we can merge the changes in to main.

Joe-Heffer-Shef · 2025-03-14T12:02:56Z

Converted to draft while I merged in Twin's unit tests with what I've written.

Merge in Twin's tests

Joe-Heffer-Shef · 2025-03-19T16:56:21Z

Is this some issue with resolving the URLs? Is it getting confused between invite/<pk>/ and invite/success/?

SORT/survey/tests/test_survey_views.py

Lines 98 to 99 in a6efc2b

    
           def test_success_invitation(self): 
        
               self.get("success_invitation")

django.urls.exceptions.NoReverseMatch: Reverse for 'invite' with no arguments not found. 1 pattern(s) tried: ['invite/(?P<pk>[0-9]+)\\Z']

SORT/survey/urls.py

Lines 56 to 61 in a6efc2b

    
           path("invite/<int:pk>", views.InvitationView.as_view(), name="invite"), 
        
           path( 
        
               "invite/success/", 
        
               views.SuccessInvitationView.as_view(), 
        
               name="success_invitation", 
        
           ),

twinkarma · 2025-03-20T11:57:40Z

@Joe-Heffer-Shef I think everything related to email invitations need a proper review altogether. It was something implemented very early on but so much has changed that something probably broke along the way. I made an issue #89 for this exact reason. I'd be tempted to just leave the invitation tests to be done in that issue.

Joe-Heffer-Shef · 2025-03-20T13:25:56Z

@Joe-Heffer-Shef I think everything related to email invitations need a proper review altogether. It was something implemented very early on but so much has changed that something probably broke along the way. I made an issue #89 for this exact reason. I'd be tempted to just leave the invitation tests to be done in that issue.

Okay, I've disabled the invite tests for now, which can be implemented separately with issue #89.

These tests all pass now. There might be some details that I've overlooked but the code coverage should be alright for now! (We could measure this.)

# Conflicts: # README.md # SORT/settings.py # assets/sort-survey-configurator/README.md # assets/sort-survey-configurator/package-lock.json # home/templatetags/vite_integration.py # survey/services/survey.py

# Conflicts: # SORT/settings.py

Add invitation view tests

twinkarma

A few minor changes need for the test class names but the rest is looking good. Let's get this merged in!

twinkarma · 2025-04-28T10:56:50Z

home/tests/test_organisation_service.py

+
+    def test_add_user_to_organisation(self):
+        """
+        Check that an organisation administrator can add another user to that organisation.


A manager won't be adding a user directly. They'll need to send an invite that generates the code, the user can then add themselves to the organisation if they have the correct code.

twinkarma · 2025-04-28T11:02:25Z

survey/tests/test_survey_views.py

+from survey.services import SurveyService
+
+
+class SurveyServiceTestCase(SORT.test.test_case.ViewTestCase):


Rename to SurveyViewsTestcase?

twinkarma · 2025-04-28T11:03:55Z

survey/tests/test_invitation_views.py

+from survey.services import SurveyService
+
+
+class SurveyServiceTestCase(SORT.test.test_case.ViewTestCase):


Rename to InvitationViewTestCase?

# Conflicts: # SORT/settings.py # home/tests/model_factory.py # home/tests/test_services.py # requirements.txt # survey/services/survey.py # survey/tests/test_models.py

Joe-Heffer-Shef · 2025-04-29T15:47:05Z

I accidentally merged this without resolving the issues above, sorry @twinkarma! I'll sort out the issues (no pun intended) next week.

Joe-Heffer-Shef added 2 commits March 13, 2025 16:52

chore(tests): Add tests to workflow

9051890

feat(tests): Add a test suite

d6570bd

Joe-Heffer-Shef linked an issue Mar 14, 2025 that may be closed by this pull request

Add unit testing to backend #144

Closed

8 tasks

Joe-Heffer-Shef mentioned this pull request Mar 14, 2025

Add unit testing to backend #144

Closed

8 tasks

chore(tests): Add survey tests placeholder

ccddc57

Joe-Heffer-Shef requested review from twinkarma and f-allian March 14, 2025 11:25

Joe-Heffer-Shef self-assigned this Mar 14, 2025

Joe-Heffer-Shef added the enhancement New feature or request label Mar 14, 2025

twinkarma reviewed Mar 14, 2025

View reviewed changes

Joe-Heffer-Shef changed the base branch from main to dev March 14, 2025 11:44

Joe-Heffer-Shef added 3 commits March 14, 2025 11:44

Merge remote-tracking branch 'refs/remotes/origin/dev' into test/backend

97c9403

chore(tests): Start adding survey tests

d449a7c

???

4539cea

Joe-Heffer-Shef marked this pull request as draft March 14, 2025 12:02

Joe-Heffer-Shef added 4 commits March 19, 2025 12:06

Tidy up the test suite

ca7ace6

Merge in Twin's tests

Fix survey service syntax

df88ea7

Fix survey service logic

67035d2

Start writing survey tests

5126cd4

Joe-Heffer-Shef marked this pull request as ready for review March 19, 2025 14:37

Joe-Heffer-Shef added 3 commits March 19, 2025 15:53

Test all survey service methods

e7ed812

Test all survey service methods

1660977

Add unit tests for survey views

a6efc2b

Disable invite test

92eabaa

Joe-Heffer-Shef removed the enhancement New feature or request label Mar 20, 2025

Joe-Heffer-Shef added 6 commits April 2, 2025 09:29

Add npm run build to testing workflow

143f057

Add npm install to testing workflow

d36ac21

Use setup-node action

8451bf8

Use npm ci

095dbee

Add link to other readme

573da49

Merge remote-tracking branch 'refs/remotes/origin/dev' into test/backend

b122beb

Joe-Heffer-Shef mentioned this pull request Apr 3, 2025

Measure coverage of unit tests #171

Closed

Joe-Heffer-Shef and others added 8 commits April 15, 2025 11:19

Merge remote-tracking branch 'refs/remotes/origin/dev' into test/backend

8c12e8e

# Conflicts: # README.md # SORT/settings.py # assets/sort-survey-configurator/README.md # assets/sort-survey-configurator/package-lock.json # home/templatetags/vite_integration.py # survey/services/survey.py

Attempt to fix unit tests

a772e60

Attempt to fix unit tests

f955cec

Delete assets/sort-survey-configurator/package-lock.json

2d832eb

Fix unit tests

01fed98

Use Node version 20

e338438

Fix JavaScript package working dir

0f59783

Fix changed ui path

26d225e

Joe-Heffer-Shef removed the request for review from f-allian April 15, 2025 14:49

Merge branch 'dev' into test/backend

4273301

Joe-Heffer-Shef mentioned this pull request Apr 23, 2025

Add test cases for the invitation services and views #240

Open

Joe-Heffer-Shef and others added 5 commits April 23, 2025 10:48

chore: Only use debug toolbar in dev

4e091db

Merge branch 'refs/heads/dev' into test/backend

2d98aa5

# Conflicts: # SORT/settings.py

chore: Only use debug toolbar in dev

1ec0623

Add invitation view tests

000998d

Merge pull request #241 from RSE-Sheffield/test/invite

03d7599

Add invitation view tests

twinkarma approved these changes Apr 28, 2025

View reviewed changes

Joe-Heffer-Shef added 2 commits April 29, 2025 16:32

Merge remote-tracking branch 'refs/remotes/origin/dev' into test/backend

29f82a8

# Conflicts: # SORT/settings.py # home/tests/model_factory.py # home/tests/test_services.py # requirements.txt # survey/services/survey.py # survey/tests/test_models.py

Fix linting errors

bdaee10

Joe-Heffer-Shef merged commit e377616 into dev Apr 29, 2025
4 checks passed

Joe-Heffer-Shef deleted the test/backend branch April 29, 2025 15:37

Joe-Heffer-Shef mentioned this pull request Jul 14, 2025

Add CI workflows for testing #8

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Write unit test suite #170

Write unit test suite #170

Uh oh!

Joe-Heffer-Shef commented Mar 14, 2025 •

edited

Loading

Uh oh!

twinkarma left a comment

Uh oh!

twinkarma commented Mar 14, 2025

Uh oh!

Joe-Heffer-Shef commented Mar 14, 2025

Uh oh!

Joe-Heffer-Shef commented Mar 19, 2025 •

edited

Loading

Uh oh!

twinkarma commented Mar 20, 2025

Uh oh!

Joe-Heffer-Shef commented Mar 20, 2025

Uh oh!

twinkarma left a comment

Uh oh!

twinkarma Apr 28, 2025

Uh oh!

twinkarma Apr 28, 2025

Uh oh!

twinkarma Apr 28, 2025

Uh oh!

Uh oh!

Joe-Heffer-Shef commented Apr 29, 2025

Uh oh!

Uh oh!

		from survey.services import SurveyService


		class SurveyServiceTestCase(SORT.test.test_case.ViewTestCase):

Write unit test suite #170

Write unit test suite #170

Uh oh!

Conversation

Joe-Heffer-Shef commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

twinkarma left a comment

Choose a reason for hiding this comment

Uh oh!

twinkarma commented Mar 14, 2025

Uh oh!

Joe-Heffer-Shef commented Mar 14, 2025

Uh oh!

Joe-Heffer-Shef commented Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

twinkarma commented Mar 20, 2025

Uh oh!

Joe-Heffer-Shef commented Mar 20, 2025

Uh oh!

twinkarma left a comment

Choose a reason for hiding this comment

Uh oh!

twinkarma Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

twinkarma Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

twinkarma Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Joe-Heffer-Shef commented Apr 29, 2025

Uh oh!

Uh oh!

Joe-Heffer-Shef commented Mar 14, 2025 •

edited

Loading

Joe-Heffer-Shef commented Mar 19, 2025 •

edited

Loading