Merge pull request #2420 from carpentries/update-training-requirements

Rename Discussion to Welcome Session, remove deprecated TrainingRequirements
carpentries · Jun 21, 2023 · 027dc20 · 027dc20
2 parents e993651 + a6288ed
commit 027dc20
Show file tree

Hide file tree

Showing 18 changed files with 422 additions and 89 deletions.
diff --git a/.github/workflows/cicd_feature_branch.yml b/.github/workflows/cicd_feature_branch.yml
@@ -0,0 +1,15 @@
+# CI for feature branches - contains only test runs
+
+name: CI (feature)
+
+# don't run CI for every push of any feature branch
+# but do run CI if a PR is made with any feature branch as a base
+on:
+  push:
+    branches: [ 'feature/instructor-checkout-changes' ]
+  pull_request:
+    branches: [ 'feature/**' ]
+
+jobs:
+  test:
+    uses: ./.github/workflows/test.yml
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -5,11 +5,12 @@ on:
 
 jobs:
   test:
-    name: Test on Python ${{ matrix.python-version }}
+    name: ${{ matrix.test-type }} tests on Python ${{ matrix.python-version }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: [ '3.11' ]
+        test-type: ["Unit", "Migration"]
 
     services:
       postgres:
@@ -82,12 +83,22 @@ jobs:
           exit 1;
         fi;
 
-    - name: Test
-      run: pipenv run python manage.py test
+    - name: Unit tests
+      run: pipenv run python manage.py test --exclude-tag=migration_test
       env:
         AMY_DATABASE_HOST: localhost
         AMY_DATABASE_PORT: 5432
         AMY_DATABASE_NAME: test_amy
         AMY_DATABASE_USER: postgres
         AMY_DATABASE_PASSWORD: postgres
+      if: matrix.test-type == 'Unit'
 
+    - name: Migration tests
+      run: pipenv run python manage.py test --tag=migration_test
+      env:
+        AMY_DATABASE_HOST: localhost
+        AMY_DATABASE_PORT: 5432
+        AMY_DATABASE_NAME: test_amy
+        AMY_DATABASE_USER: postgres
+        AMY_DATABASE_PASSWORD: postgres
+      if: matrix.test-type == 'Migration'
diff --git a/Makefile b/Makefile
@@ -11,17 +11,21 @@ all : commands
 commands : Makefile
 	@sed -n 's/^## //p' $<
 
-## test         : run all tests.
+## test         : run all tests except migration tests.
 test :
-	${MANAGE} test
+	${MANAGE} test --exclude-tag migration_test
 
 ## fast_test    : run all tests really fast.
 fast_test:
-	${MANAGE} test --keepdb --parallel
+	${MANAGE} test --keepdb --parallel --exclude-tag migration_test
 
 ## fast_test_fail	: run all tests really fast, fails as soon as any test fails.
 fast_test_fail:
-	${MANAGE} test --keepdb --parallel --failfast
+	${MANAGE} test --keepdb --parallel --failfast --exclude-tag migration_test
+
+## test_migrations    : test database migrations only
+test_migrations:
+	${MANAGE} test --parallel --tag migration_test
 
 ## dev_database : re-make database using saved data
 dev_database :

diff --git a/Pipfile b/Pipfile
@@ -37,6 +37,7 @@ social-auth-app-django = "~=5.0.0"
 gunicorn = "~=20.1.0"
 whitenoise = "~=6.1"
 django-better-admin-arrayfield = "==1.4.2"
+django-test-migrations = "~=1.3.0"
 
 [dev-packages]
 django-webtest = "~=1.9.8"

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/amy/api/tests/test_export.py b/amy/api/tests/test_export.py
@@ -180,7 +180,7 @@ def prepare_data(self, user):
         # add some training progress
         TrainingProgress.objects.create(
             trainee=self.user,
-            requirement=TrainingRequirement.objects.get(name="Discussion"),
+            requirement=TrainingRequirement.objects.get(name="Welcome Session"),
             state="p",  # passed
             event=event,
             url=None,
@@ -504,7 +504,7 @@ def test_relational_fields_structure(self):
                 "created_at": data["training_progresses"][0]["created_at"],
                 "last_updated_at": data["training_progresses"][0]["last_updated_at"],
                 "requirement": {
-                    "name": "Discussion",
+                    "name": "Welcome Session",
                     "url_required": False,
                     "event_required": False,
                 },

diff --git a/amy/dashboard/tests/test_instructor_dashboard.py b/amy/dashboard/tests/test_instructor_dashboard.py
@@ -36,10 +36,6 @@ def setUp(self):
         self._setUpUsersAndLogin()
         self._setUpBadges()
         self.progress_url = reverse("training-progress")
-        TrainingRequirement.objects.create(
-            name="Lesson Contribution", url_required=True
-        )
-        TrainingRequirement.objects.create(name="Demo")
 
     def test_instructor_badge(self):
         """When the trainee is awarded both Carpentry Instructor badge,
@@ -67,7 +63,7 @@ def test_eligible_but_not_awarded(self):
         requirements = [
             "Training",
             "Lesson Contribution",
-            "Discussion",
+            "Welcome Session",
             "Demo",
         ]
         for requirement in requirements:
@@ -175,31 +171,31 @@ def test_submission_form(self):
         self.assertEqual(got, expected)
 
 
-class TestDiscussionSessionStatus(TestBase):
-    """Test that trainee dashboard displays status of passing Discussion
+class TestWelcomeSessionStatus(TestBase):
+    """Test that trainee dashboard displays status of passing Welcome
     Session. Test whether we display instructions for registering for a
     session."""
 
     def setUp(self):
         self._setUpUsersAndLogin()
-        self.discussion = TrainingRequirement.objects.get(name="Discussion")
+        self.welcome = TrainingRequirement.objects.get(name="Welcome Session")
         self.progress_url = reverse("training-progress")
 
     def test_session_passed(self):
-        TrainingProgress.objects.create(trainee=self.admin, requirement=self.discussion)
+        TrainingProgress.objects.create(trainee=self.admin, requirement=self.welcome)
         rv = self.client.get(self.progress_url)
-        self.assertContains(rv, "Discussion Session passed")
+        self.assertContains(rv, "Welcome Session passed")
 
     def test_session_failed(self):
         TrainingProgress.objects.create(
-            trainee=self.admin, requirement=self.discussion, state="f"
+            trainee=self.admin, requirement=self.welcome, state="f"
         )
         rv = self.client.get(self.progress_url)
-        self.assertContains(rv, "Discussion Session not passed yet")
+        self.assertContains(rv, "Welcome Session not passed yet")
 
     def test_no_participation_in_a_session_yet(self):
         rv = self.client.get(self.progress_url)
-        self.assertContains(rv, "Discussion Session not passed yet")
+        self.assertContains(rv, "Welcome Session not passed yet")
 
 
 class TestDemoSessionStatus(TestBase):

diff --git a/amy/scripts/seed_training_requirements.py b/amy/scripts/seed_training_requirements.py
@@ -9,7 +9,14 @@
 # If an entry needs to be removed from the database, remove it from e.g.
 # `EMAIL_TEMPLATES`, and put its' ID in `DEPRECATED_EMAIL_TEMPLATES`.
 
-DEPRECATED_TRAINING_REQUIREMENTS: list[str] = []
+DEPRECATED_TRAINING_REQUIREMENTS: list[str] = [
+    "DC Homework",
+    "SWC Homework",
+    "LC Homework",
+    "DC Demo",
+    "SWC Demo",
+    "LC Demo",
+]
 
 TrainingRequirementDef = TypedDict(
     "TrainingRequirementDef",
@@ -22,13 +29,7 @@
 
 TRAINING_REQUIREMENTS: list[TrainingRequirementDef] = [
     {"name": "Training", "url_required": False, "event_required": True},
-    {"name": "DC Homework", "url_required": True, "event_required": False},
-    {"name": "SWC Homework", "url_required": True, "event_required": False},
-    {"name": "Discussion", "url_required": False, "event_required": False},
-    {"name": "DC Demo", "url_required": False, "event_required": False},
-    {"name": "SWC Demo", "url_required": False, "event_required": False},
-    {"name": "LC Demo", "url_required": False, "event_required": False},
-    {"name": "LC Homework", "url_required": True, "event_required": False},
+    {"name": "Welcome Session", "url_required": False, "event_required": False},
     {"name": "Lesson Contribution", "url_required": True, "event_required": False},
     {"name": "Demo", "url_required": False, "event_required": False},
 ]

diff --git a/amy/templates/dashboard/training_progress.html b/amy/templates/dashboard/training_progress.html
@@ -81,13 +81,13 @@ <h2>Your progress of becoming The Carpentries Instructor</h2>
       </td>
     </tr>
     <tr>
-      <th>3. Discussion Session</th>
+      <th>3. Welcome Session</th>
       <td>
-        {% if user.passed_discussion %}
-          <p class="text-success">Discussion Session passed.</p>
+        {% if user.passed_welcome %}
+          <p class="text-success">Welcome Session passed.</p>
         {% else %}
-          <p>Discussion Session not passed yet.</p>
-          <p>Register for a Discussion Session on <a href="https://pad.carpentries.org/community-discussions">this Etherpad</a>. Register for only one session even if you want to become an Instructor for more than one Carpentry lesson program.</p>
+          <p>Welcome Session not passed yet.</p>
+          <p>Register for a Welcome Session on <a href="https://pad.carpentries.org/community-discussions">this Etherpad</a>. Register for only one session even if you want to become an Instructor for more than one Carpentry lesson program.</p>
         {% endif %}
       </td>
     </tr>

diff --git a/amy/trainings/forms.py b/amy/trainings/forms.py
@@ -1,7 +1,6 @@
 from crispy_forms.layout import Layout
 from django import forms
 from django.core.exceptions import ValidationError
-from django.db.models import Q
 from django.forms import RadioSelect, TextInput
 
 # this is used instead of Django Autocomplete Light widgets
@@ -19,11 +18,7 @@ class TrainingProgressForm(forms.ModelForm):
         widget=ModelSelect2Widget(data_view="person-lookup"),
     )
     requirement = forms.ModelChoiceField(
-        queryset=TrainingRequirement.objects.exclude(
-            Q(name__startswith="SWC")
-            | Q(name__startswith="DC")
-            | Q(name__startswith="LC")
-        ),
+        queryset=TrainingRequirement.objects.all(),
         label="Type",
         required=True,
     )
@@ -92,11 +87,7 @@ class BulkAddTrainingProgressForm(forms.ModelForm):
     trainees = forms.ModelMultipleChoiceField(queryset=Person.objects.all())
 
     requirement = forms.ModelChoiceField(
-        queryset=TrainingRequirement.objects.exclude(
-            Q(name__startswith="SWC")
-            | Q(name__startswith="DC")
-            | Q(name__startswith="LC")
-        ),
+        queryset=TrainingRequirement.objects.all(),
         label="Type",
         required=True,
     )