[PERF-321] Import deadlock fix (#99)

* Moved student assessment tests to remove cycle and additional dependency fixes

* comment cleanup

Author: vimayya

src/edfi-performance-test/edfi_performance_test/api/client/academic_week.py

@@ -4,7 +4,18 @@
 # See the LICENSE and NOTICES files in the project root for more information.
 
 from edfi_performance_test.api.client.ed_fi_api_client import EdFiAPIClient
+from edfi_performance_test.api.client.school import SchoolClient
 
 
 class AcademicWeekClient(EdFiAPIClient):
     endpoint = "academicWeeks"
+
+    def create_with_dependencies(self, **kwargs):
+        # Pre-populate school
+        school_id = kwargs.pop("schoolId", SchoolClient.shared_elementary_school_id())
+
+        # Create academicWeek
+        return self.create_using_dependencies(
+            schoolReference__schoolId=school_id,
+            **kwargs
+        )

src/edfi-performance-test/edfi_performance_test/api/client/assessment.py

@@ -55,22 +55,3 @@ def create_with_dependencies(self, **kwargs):
             ]["assessmentIdentifier"],
             **kwargs
         )
-
-
-class StudentAssessmentClient(EdFiAPIClient):
-    endpoint = "studentAssessments"
-
-    dependencies: Dict = {AssessmentClient: {}}
-
-    def create_with_dependencies(self, **kwargs):
-        # Create new assessment
-        assessment_reference = self.assessment_client.create_with_dependencies()
-
-        # Create student assessment
-        return self.create_using_dependencies(
-            assessment_reference,
-            assessmentReference__assessmentIdentifier=assessment_reference[
-                "attributes"
-            ]["assessmentIdentifier"],
-            **kwargs
-        )

src/edfi-performance-test/edfi_performance_test/api/client/post_secondary.py

@@ -3,28 +3,13 @@
 # The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0.
 # See the LICENSE and NOTICES files in the project root for more information.
 
-
-import threading
 from edfi_performance_test.api.client.ed_fi_api_client import EdFiAPIClient
+from edfi_performance_test.api.client.student import StudentClient
 
 
 class PostSecondaryInstitutionClient(EdFiAPIClient):
     endpoint = "postSecondaryInstitutions"
 
-    _post_secondary_institute_id = None
-    _lock = threading.Lock()
-
-    @classmethod
-    def shared_post_secondary_institute_id(cls):
-        if cls._post_secondary_institute_id is not None:
-            return cls._post_secondary_institute_id
-        else:
-            with cls._lock:
-                if cls._post_secondary_institute_id is not None:
-                    return cls._post_secondary_institute_id
-                cls._post_secondary_institute_id = cls.create_shared_resource("postSecondaryInstitutionId")
-            return cls._post_secondary_institute_id
-
 
 class PostSecondaryEventClient(EdFiAPIClient):
     endpoint = "postSecondaryEvents"
@@ -34,6 +19,9 @@ class PostSecondaryEventClient(EdFiAPIClient):
     }
 
     def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
+
         # Create new student for association
         institution_reference = self.institution_client.create_with_dependencies()
 
@@ -44,5 +32,6 @@ def create_with_dependencies(self, **kwargs):
             ][
                 "postSecondaryInstitutionId"
             ],
+            studentReference__studentUniqueId=studentUniqueId,
             **kwargs
         )

src/edfi-performance-test/edfi_performance_test/api/client/report_card.py

@@ -6,6 +6,7 @@
 from typing import Dict
 from edfi_performance_test.api.client.ed_fi_api_client import EdFiAPIClient
 from edfi_performance_test.api.client.grading_period import GradingPeriodClient
+from edfi_performance_test.api.client.student import StudentClient
 
 
 class ReportCardClient(EdFiAPIClient):
@@ -16,11 +17,14 @@ class ReportCardClient(EdFiAPIClient):
     }
 
     def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
         period_reference = self.grading_period_client.create_with_dependencies()
 
         return self.create_using_dependencies(
             period_reference,
             gradingPeriodReference__periodSequence=period_reference["attributes"][
                 "periodSequence"
             ],
+            studentReference__studentUniqueId=studentUniqueId,
         )

src/edfi-performance-test/edfi_performance_test/api/client/restraint.py

@@ -4,7 +4,18 @@
 # See the LICENSE and NOTICES files in the project root for more information.
 
 from edfi_performance_test.api.client.ed_fi_api_client import EdFiAPIClient
+from edfi_performance_test.api.client.student import StudentClient
 
 
 class RestraintEventClient(EdFiAPIClient):
     endpoint = "restraintEvents"
+
+    def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
+
+        # Create restraint event
+        return self.create_using_dependencies(
+            studentReference__studentUniqueId=studentUniqueId,
+            **kwargs
+        )

src/edfi-performance-test/edfi_performance_test/api/client/student.py

@@ -1,4 +1,4 @@
-# SPDX-License-Identifier: Apache-2.0
+# SPDX-License-Identifier: Apache-2.0
 # Licensed to the Ed-Fi Alliance under one or more agreements.
 # The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0.
 # See the LICENSE and NOTICES files in the project root for more information.
@@ -7,6 +7,7 @@
 
 from edfi_performance_test.api.client.ed_fi_api_client import EdFiAPIClient
 from edfi_performance_test.api.client.assessment import LearningObjectiveClient
+from edfi_performance_test.api.client.assessment import AssessmentClient
 from edfi_performance_test.api.client.competency_objective import (
     CompetencyObjectiveClient,
 )
@@ -453,6 +454,9 @@ class StudentCompetencyObjectiveClient(EdFiAPIClient):
     }
 
     def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
+
         # Create grading period
         period_reference = self.grading_period_client.create_with_dependencies()
 
@@ -473,16 +477,36 @@ def create_with_dependencies(self, **kwargs):
             objectiveCompetencyObjectiveReference__objective=objective_reference[
                 "attributes"
             ]["objective"],
+            studentReference__studentUniqueId=studentUniqueId,
         )
 
 
 class StudentCTEProgramAssociationClient(EdFiAPIClient):
     endpoint = "studentCTEProgramAssociations"
 
+    def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
+
+        return self.create_using_dependencies(
+            studentReference__studentUniqueId=studentUniqueId,
+            **kwargs
+        )
+
 
 class StudentEducationOrganizationResponsibilityAssociationClient(EdFiAPIClient):
     endpoint = "studentEducationOrganizationResponsibilityAssociations"
 
+    def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
+
+        # Create student academic record
+        return self.create_using_dependencies(
+            studentReference__studentUniqueId=studentUniqueId,
+            **kwargs
+        )
+
 
 class StudentGradebookEntryClient(EdFiAPIClient):
     endpoint = "studentGradebookEntries"
@@ -551,6 +575,16 @@ def delete_with_dependencies(self, reference, **kwargs):
 class StudentHomelessProgramAssociationClient(EdFiAPIClient):
     endpoint = "studentHomelessProgramAssociations"
 
+    def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
+
+        # Create student academic record
+        return self.create_using_dependencies(
+            studentReference__studentUniqueId=studentUniqueId,
+            **kwargs
+        )
+
 
 class StudentInterventionAssociationClient(EdFiAPIClient):
     endpoint = "studentInterventionAssociations"
@@ -560,6 +594,9 @@ class StudentInterventionAssociationClient(EdFiAPIClient):
     }
 
     def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
+
         intervention_reference = self.intervention_client.create_with_dependencies()
 
         return self.create_using_dependencies(
@@ -569,6 +606,7 @@ def create_with_dependencies(self, **kwargs):
             ][
                 "interventionIdentificationCode"
             ],
+            studentReference__studentUniqueId=studentUniqueId,
             **kwargs
         )
 
@@ -581,6 +619,9 @@ class StudentInterventionAttendanceEventClient(EdFiAPIClient):
     }
 
     def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
+
         intervention_reference = self.intervention_client.create_with_dependencies()
 
         return self.create_using_dependencies(
@@ -590,13 +631,24 @@ def create_with_dependencies(self, **kwargs):
             ][
                 "interventionIdentificationCode"
             ],
+            studentReference__studentUniqueId=studentUniqueId,
             **kwargs
         )
 
 
 class StudentLanguageInstructionProgramAssociationClient(EdFiAPIClient):
     endpoint = "studentLanguageInstructionProgramAssociations"
 
+    def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
+
+        # Create student academic record
+        return self.create_using_dependencies(
+            studentReference__studentUniqueId=studentUniqueId,
+            **kwargs
+        )
+
 
 class StudentLearningObjectiveClient(EdFiAPIClient):
     endpoint = "studentLearningObjectives"
@@ -607,6 +659,9 @@ class StudentLearningObjectiveClient(EdFiAPIClient):
     }
 
     def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
+
         objective_reference = self.objective_client.create_with_dependencies()
 
         period_reference = self.grading_period_client.create_with_dependencies()
@@ -622,21 +677,85 @@ def create_with_dependencies(self, **kwargs):
             gradingPeriodReference__periodSequence=period_reference["attributes"][
                 "periodSequence"
             ],
+            studentReference__studentUniqueId=studentUniqueId,
             **kwargs
         )
 
 
 class StudentMigrantEducationProgramAssociationClient(EdFiAPIClient):
     endpoint = "studentMigrantEducationProgramAssociations"
 
+    def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
+
+        # Create student academic record
+        return self.create_using_dependencies(
+            studentReference__studentUniqueId=studentUniqueId,
+            **kwargs
+        )
+
 
 class StudentNeglectedOrDelinquentProgramAssociationClient(EdFiAPIClient):
     endpoint = "studentNeglectedOrDelinquentProgramAssociations"
 
+    def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
+
+        # Create student academic record
+        return self.create_using_dependencies(
+            studentReference__studentUniqueId=studentUniqueId,
+            **kwargs
+        )
+
 
 class StudentProgramAttendanceEventClient(EdFiAPIClient):
     endpoint = "studentProgramAttendanceEvents"
 
+    def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
+
+        # Create student academic record
+        return self.create_using_dependencies(
+            studentReference__studentUniqueId=studentUniqueId,
+            **kwargs
+        )
+
 
 class StudentSchoolFoodServiceProgramAssociationClient(EdFiAPIClient):
     endpoint = "studentSchoolFoodServiceProgramAssociations"
+
+    def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
+
+        # Create student academic record
+        return self.create_using_dependencies(
+            studentReference__studentUniqueId=studentUniqueId,
+            **kwargs
+        )
+
+
+class StudentAssessmentClient(EdFiAPIClient):
+    endpoint = "studentAssessments"
+
+    dependencies: Dict = {AssessmentClient: {}}
+
+    def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
+
+        # Create new assessment
+        assessment_reference = self.assessment_client.create_with_dependencies()
+
+        # Create student assessment
+        return self.create_using_dependencies(
+            assessment_reference,
+            assessmentReference__assessmentIdentifier=assessment_reference[
+                "attributes"
+            ]["assessmentIdentifier"],
+            studentReference__studentUniqueId=studentUniqueId,
+            **kwargs
+        )

src/edfi-performance-test/edfi_performance_test/api/client/v4/assessment.py

@@ -7,6 +7,7 @@
 
 from edfi_performance_test.api.client.ed_fi_api_client import EdFiAPIClient
 from edfi_performance_test.api.client.school import SchoolClient
+from edfi_performance_test.api.client.student import StudentClient
 
 
 class StudentAssessmentEducationOrganizationAssociationClient(EdFiAPIClient):
@@ -19,6 +20,8 @@ class StudentAssessmentEducationOrganizationAssociationClient(EdFiAPIClient):
     }
 
     def create_with_dependencies(self, **kwargs):
+        # Prepopulated student
+        studentUniqueId = kwargs.pop("studentUniqueId", StudentClient.shared_student_id())
 
         assessment_reference = self.assessment_client.create_with_dependencies()
 
@@ -34,8 +37,6 @@ def create_with_dependencies(self, **kwargs):
             studentAssessmentReference__studentAssessmentIdentifier=assessment_reference[
                 "attributes"
             ]["studentAssessmentIdentifier"],
-            studentAssessmentReference__studentUniqueId=assessment_reference[
-                "attributes"
-            ]["studentReference"]["studentUniqueId"],
+            studentAssessmentReference__studentUniqueId=studentUniqueId,
             **kwargs
         )