Add student data to dev seeds (#376)

closes #339

---------

Co-authored-by: create-issue-branch[bot] <53036503+create-issue-branch[bot]@users.noreply.github.com>
Co-authored-by: Dan Halson <[email protected]>

Author: create-issue-branch[bot]

README.md

@@ -75,7 +75,7 @@ For classroom management the following scenarios modelled by the tasks:
 
 `rails classroom_management:seed_an_unverified_school` - seeds an unverified school to test the onboarding flow
 `rails classroom_management:seed_a_verified_school` - seeds only a verified school
-`rails classroom_management:seed_a_school_with_lessons` - seeds a school with a class, two lessons, and a project in each
+`rails classroom_management:seed_a_school_with_lessons_and_students` - seeds a school with a class, two lessons, a project in each, and two students
 
 To clear classroom management data the following cmd will remove the school associated with the `[email protected]` user, and associated school data:
 
@@ -85,7 +85,9 @@ To override values, you can prefix the tasks with environment variables, for exa
 
 `SEEDING_CREATOR_ID=00000000-0000-0000-0000-000000000000 rails classroom_management:seed_a_verified_school`
 
-Also avilable to override are: `SEEDING_TEACHER_ID`, `SEEDING_SCHOOL_ID`
+Also avilable to override are: `SEEDING_TEACHER_ID`.
+
+> NOTE: The student ids and school id in the CM seeds are hard coded to match profile seed data.
 
 #### Syncing the database from Production / Staging
 

lib/tasks/classroom_management.rake

@@ -8,6 +8,8 @@ Rails.logger = Logger.new($stdout) unless Rails.env.test?
 # `SEEDING_CREATOR_ID=00000000-0000-0000-0000-000000000000 rails classroom_management:seed_an_unverified_school`
 # `SEEDING_TEACHER_ID=00000000-0000-0000-0000-000000000000 rails classroom_management:seed_a_school_with_lessons`
 
+# For students to match up the school needs to match with the school defined in profile (hard coded in the helper)
+
 # rubocop:disable Metrics/BlockLength
 namespace :classroom_management do
   include ClassroomManagementHelper
@@ -16,23 +18,29 @@ namespace :classroom_management do
   task destroy_seed_data: :environment do
     ActiveRecord::Base.transaction do
       Rails.logger.info 'Destroying existing seeds...'
-      creator_id = ENV.fetch('SEEDING_CREATOR_ID', TEST_USERS[:jane])
-      teacher_id = ENV.fetch('SEEDING_TEACHER_ID', TEST_USERS[:john])
-      school_id = ENV.fetch('SEEDING_SCHOOL_ID', School.find_by(creator_id:)&.id)
+      creator_id = ENV.fetch('SEEDING_CREATOR_ID', TEST_USERS[:jane_doe])
+      teacher_id = ENV.fetch('SEEDING_TEACHER_ID', TEST_USERS[:john_doe])
 
-      Role.where(user_id: [creator_id, teacher_id]).destroy_all
+      # Hard coded as the student's school needs to match
+      student_ids = [TEST_USERS[:jane_smith], TEST_USERS[:john_smith]]
+      school_id = TEST_SCHOOL
 
-      if school_id.nil? || creator_id.nil?
-        Rails.logger.info 'No school found for creator, exiting...'
-        exit
-      end
+      # Remove the roles first
+      Role.where(user_id: [creator_id, teacher_id] + student_ids).destroy_all
+
+      # Destroy the project and then the lesson itself (The lesson's `before_destroy` prevents us using destroy)
+      lesson_ids = Lesson.where(school_id:).pluck(:id)
+      Project.where(lesson_id: [lesson_ids]).destroy_all
+      Lesson.where(id: [lesson_ids]).delete_all
+
+      # Destroy the class members and then the class itself
+      school_class_ids = SchoolClass.where(school_id:).pluck(:id)
+      ClassMember.where(school_class_id: [school_class_ids]).destroy_all
+      SchoolClass.where(id: [school_class_ids]).destroy_all
+
+      # Destroy the school
+      School.find(school_id).destroy
 
-      lesson_id = Lesson.where(school_id:).pluck(:id)
-      Project.where(lesson_id:).destroy_all
-      # The `before_destroy` prevents us using destroy, but as we've removed projects already we can safely delete
-      Lesson.where(school_id:).delete_all
-      SchoolClass.where(school_id:).destroy_all
-      School.where(creator_id:).destroy_all
       Rails.logger.info 'Done...'
     rescue StandardError => e
       Rails.logger.error "Failed: #{e.message}"
@@ -44,8 +52,9 @@ namespace :classroom_management do
   task seed_an_unverified_school: :environment do
     ActiveRecord::Base.transaction do
       Rails.logger.info 'Attempting to seed data...'
-      creator_id = ENV.fetch('SEEDING_CREATOR_ID', TEST_USERS[:jane])
-      create_school(creator_id)
+      creator_id = ENV.fetch('SEEDING_CREATOR_ID', TEST_USERS[:jane_doe])
+      create_school(creator_id, TEST_SCHOOL)
+
       Rails.logger.info 'Done...'
     rescue StandardError => e
       Rails.logger.error "Failed: #{e.message}"
@@ -57,9 +66,9 @@ namespace :classroom_management do
   task seed_a_verified_school: :environment do
     ActiveRecord::Base.transaction do
       Rails.logger.info 'Attempting to seed data...'
-      creator_id = ENV.fetch('SEEDING_CREATOR_ID', TEST_USERS[:jane])
-      school_id = ENV.fetch('SEEDING_SCHOOL_ID', nil)
-      school = create_school(creator_id, school_id)
+      creator_id = ENV.fetch('SEEDING_CREATOR_ID', TEST_USERS[:jane_doe])
+
+      school = create_school(creator_id, TEST_SCHOOL)
       verify_school(school)
       Rails.logger.info 'Done...'
     rescue StandardError => e
@@ -68,19 +77,20 @@ namespace :classroom_management do
     end
   end
 
-  desc 'Create a school with lessons'
-  task seed_a_school_with_lessons: :environment do
+  desc 'Create a school with lessons and students'
+  task seed_a_school_with_lessons_and_students: :environment do
     ActiveRecord::Base.transaction do
       Rails.logger.info 'Attempting to seed data...'
-      creator_id = ENV.fetch('SEEDING_CREATOR_ID', TEST_USERS[:jane])
-      teacher_id = ENV.fetch('SEEDING_TEACHER_ID', TEST_USERS[:john])
-      school_id = ENV.fetch('SEEDING_SCHOOL_ID', nil)
+      creator_id = ENV.fetch('SEEDING_CREATOR_ID', TEST_USERS[:jane_doe])
+      teacher_id = ENV.fetch('SEEDING_TEACHER_ID', TEST_USERS[:john_doe])
 
-      school = create_school(creator_id, school_id)
+      school = create_school(creator_id, TEST_SCHOOL)
       verify_school(school)
       assign_a_teacher(teacher_id, school)
 
       school_class = create_school_class(creator_id, school)
+      assign_students(school_class, school)
+
       lessons = create_lessons(creator_id, school, school_class)
       lessons.each do |lesson|
         create_project(creator_id, school, lesson)

lib/tasks/classroom_management_helper.rb

@@ -4,10 +4,14 @@ module ClassroomManagementHelper
   TEST_USERS = {
     # Use this in conjunction with BYPASS_OAUTH=true to generate data for the bypass user
     bypass_oauth: '00000000-0000-0000-0000-000000000000',
-    jane: '583ba872-b16e-46e1-9f7d-df89d267550d', # [email protected]
-    john: 'bbb9b8fd-f357-4238-983d-6f87b99bdbb2' # [email protected]
+    jane_doe: '583ba872-b16e-46e1-9f7d-df89d267550d', # [email protected]
+    john_doe: 'bbb9b8fd-f357-4238-983d-6f87b99bdbb2', # [email protected]
+    jane_smith: 'e52de409-9210-4e94-b08c-dd11439e07d9', # student
+    john_smith: '0d488bec-b10d-46d3-b6f3-4cddf5d90c71' # student
   }.freeze
 
+  TEST_SCHOOL = 'e52de409-9210-4e94-b08c-dd11439e07d9'
+
   def create_school(creator_id, school_id = nil)
     School.find_or_create_by!(creator_id:, id: school_id) do |school|
       Rails.logger.info 'Seeding a school...'
@@ -44,6 +48,19 @@ def assign_a_teacher(user_id, school)
     Role.teacher.find_or_create_by!(user_id:, school:)
   end
 
+  def assign_students(school_class, school)
+    [TEST_USERS[:jane_smith], TEST_USERS[:john_smith]].map do |student_id|
+      Rails.logger.info 'Assigning student role...'
+      Role.student.find_or_create_by!(user_id: student_id, school:)
+
+      ClassMember.find_or_create_by!(student_id:, school_class:) do |class_member|
+        Rails.logger.info 'Adding student...'
+        class_member.student_id = student_id
+        class_member.school_class = school_class
+      end
+    end
+  end
+
   # rubocop:disable Metrics/AbcSize
   def create_lessons(user_id, school, school_class, visibility = 'public')
     2.times.map do |i|

spec/lib/classroom_management_spec.rb

@@ -6,23 +6,29 @@
 RSpec.describe 'classroom_management', type: :task do
   let(:creator_id) { '583ba872-b16e-46e1-9f7d-df89d267550d' } # [email protected]
   let(:teacher_id) { 'bbb9b8fd-f357-4238-983d-6f87b99bdbb2' } # [email protected]
+  let(:student_1) { 'e52de409-9210-4e94-b08c-dd11439e07d9' } # student
+  let(:student_2) { '0d488bec-b10d-46d3-b6f3-4cddf5d90c71' } # student
+  let(:school_id) { 'e52de409-9210-4e94-b08c-dd11439e07d9' }
 
   describe ':destroy_seed_data' do
     let(:task) { Rake::Task['classroom_management:destroy_seed_data'] }
-    let(:school) { create(:school, creator_id:) }
+    let(:school) { create(:school, creator_id:, id: school_id) }
 
     before do
       create(:role, user_id: creator_id, school:)
+      create(:student_role, user_id: student_1, school:)
       create(:teacher_role, user_id: creator_id, school:)
-      create(:school_class, school_id: school.id, teacher_id: creator_id)
+      school_class = create(:school_class, school_id: school.id, teacher_id: creator_id)
+      create(:class_member, student_id: student_1, school_class_id: school_class.id)
       create(:lesson, school_id: school.id, user_id: creator_id)
     end
 
     # rubocop:disable RSpec/ExampleLength, RSpec/MultipleExpectations
     it 'destroys all seed data' do
       task.invoke
-      expect(Role.where(user_id: creator_id)).not_to exist
+      expect(Role.where(user_id: [creator_id, teacher_id, student_1, student_2])).not_to exist
       expect(School.where(creator_id:)).not_to exist
+      expect(ClassMember.where(student_id: student_1)).not_to exist
       expect(SchoolClass.where(school_id: school.id)).not_to exist
       expect(Lesson.where(school_id: school.id)).not_to exist
       expect(Project.where(school_id: school.id)).not_to exist
@@ -48,8 +54,8 @@
     end
   end
 
-  describe ':seed_a_school_with_lessons' do
-    let(:task) { Rake::Task['classroom_management:seed_a_school_with_lessons'] }
+  describe ':seed_a_school_with_lessons_and_students' do
+    let(:task) { Rake::Task['classroom_management:seed_a_school_with_lessons_and_students'] }
 
     before do
       task.invoke
@@ -73,5 +79,16 @@
       school = School.find_by(creator_id:)
       expect(Role.teacher.where(user_id: teacher_id, school_id: school.id)).to exist
     end
+
+    # rubocop:disable RSpec/MultipleExpectations, RSpec/ExampleLength
+    it 'assigns students' do
+      school_id = School.find_by(creator_id:).id
+      school_class_id = SchoolClass.find_by(school_id:).id
+      expect(Role.student.where(user_id: student_1, school_id:)).to exist
+      expect(ClassMember.where(student_id: student_1, school_class_id:)).to exist
+      expect(Role.student.where(user_id: student_2, school_id:)).to exist
+      expect(ClassMember.where(student_id: student_2, school_class_id:)).to exist
+    end
+    # rubocop:enable RSpec/MultipleExpectations, RSpec/ExampleLength
   end
 end