[SEASK-96] Update SEA starter kit to include TPDM core (#52)

* added tpdm to SEA starter kit * removed tpdm schema mapping tpdm schema files not required for loading starter kit data, its presence causes issues with bulk load. * using tpdm as start template approach with installing the extension * fixed template setting * another try on setting tpdm template * adjusted data scripts for TPDM sample data * sk extension package update * build update to include tpdm * build update to include tpdm * updated sample data package * updated postman collections to account for tpdm data set
Ed-Fi-Exchange-OSS · Dec 3, 2021 · b2443cd · b2443cd
1 parent 350a7f9
commit b2443cd
Show file tree

Hide file tree

Showing 12 changed files with 140 additions and 21 deletions.
diff --git a/.github/workflows/build.ps1 b/.github/workflows/build.ps1
@@ -8,7 +8,9 @@ $ErrorActionPreference = 'Stop'
 & ([scriptblock]::Create((Invoke-WebRequest -UseBasicParsing 'https://dot.net/v1/dotnet-install.ps1'))) -Channel 3.1 -InstallDir 'C:/Program Files/dotnet'
 dotnet user-secrets set --id f1506d66-289c-44cb-a2e2-80411cc690ec 'Plugin:Folder' '../../Plugin'
 dotnet user-secrets set --id f1506d66-289c-44cb-a2e2-80411cc690ed 'Plugin:Folder' '../../Plugin'
-dotnet user-secrets set --id f1506d66-289c-44cb-a2e2-80411cc690ec 'Plugin:Scripts:0' 'sk'
-dotnet user-secrets set --id f1506d66-289c-44cb-a2e2-80411cc690ed 'Plugin:Scripts:0' 'sk'
+dotnet user-secrets set --id f1506d66-289c-44cb-a2e2-80411cc690ec 'Plugin:Scripts:0' 'tpdm'
+dotnet user-secrets set --id f1506d66-289c-44cb-a2e2-80411cc690ed 'Plugin:Scripts:0' 'tpdm'
+dotnet user-secrets set --id f1506d66-289c-44cb-a2e2-80411cc690ec 'Plugin:Scripts:1' 'sk'
+dotnet user-secrets set --id f1506d66-289c-44cb-a2e2-80411cc690ed 'Plugin:Scripts:1' 'sk'
 . C:/Ed-Fi-ODS-Implementation/Initialize-PowershellForDevelopment.ps1
 Initialize-DevelopmentEnvironment -RunDotnetTest -RunSdkGen -RunSmokeTest
diff --git a/packer/build-configuration.json b/packer/build-configuration.json
@@ -18,7 +18,7 @@
       "package_name": "EdFi.Suite3.RestApi.Databases"
     },
     "sampledata": {
-      "version": "1.0.255",
+      "version": "1.0.266",
       "package_name": "EdFi.Ods.Populated.Template.SK"
     }
   }

diff --git a/packer/scripts/configuration.json b/packer/scripts/configuration.json
@@ -61,6 +61,6 @@
     },
     "Plugin": {
       "Folder": "c:/plugin",
-      "Scripts": ["sk"]
+      "Scripts": [ "tpdm","sk" ]
     }
   }
diff --git a/packer/scripts/sk.ps1 b/packer/scripts/sk.ps1
@@ -12,7 +12,7 @@ $pluginPaths = @()
 
 $parameters = @{
     packageName     = "EdFi.Suite3.Ods.Extensions.SK"
-    packageVersion  = "5.3.36"
+    packageVersion  = "5.3.37"
     packageSource   = "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/nuget/v3/index.json"
     outputDirectory = "$PSScriptRoot"
     toolsPath       = (Get-ToolsPath)

diff --git a/packer/scripts/webapi.appsettings.production.json b/packer/scripts/webapi.appsettings.production.json
@@ -1,6 +1,6 @@
 {
   "Plugin": {
     "Folder": "c:/plugin",
-    "Scripts": ["sk"]
+    "Scripts": [ "tpdm","sk" ]
   }
 }
diff --git a/packer/sea-starter-kit-win2019-eval.pkr.hcl b/packer/sea-starter-kit-win2019-eval.pkr.hcl
@@ -222,6 +222,7 @@ build {
       "Copy-Item -Path ./${var.archive_name}/configuration.json -Destination ./${var.databases}",
       "Copy-Item -Path ./${var.archive_name}/sampledata.ps1 -Destination ./${var.databases}/Ed-Fi-ODS-Implementation/DatabaseTemplate/Scripts/",
       "Copy-Item -Path ./${var.archive_name}/sk.ps1 -Destination c:/plugin -Force",
+      "Copy-Item -Path ./${var.databases}/Ed-Fi-ODS-Implementation/Plugin/tpdm.ps1 -Destination c:/plugin -Force",
       "New-Item -ItemType Directory -Path ./${var.databases}/Ed-Fi-ODS-Implementation/Artifacts/MsSql/Structure/Ods/",
       "Get-ChildItem c:/${var.starter_kit_directory}/${var.sample_report}/* -filter '*-Create*.sql' | Move-Item -Destination ./${var.databases}/Ed-Fi-ODS-Implementation/Artifacts/MsSql/Structure/Ods/",
       "Copy-Item ./${var.sample_validation}/* ./${var.databases}/Ed-Fi-ODS-Implementation/Artifacts/MsSql/Structure/Ods/ -filter '*.sql' -recurse",

diff --git a/sample-api-calls/SEA Modernization Starter Kit Rectification.postman_collection.json b/sample-api-calls/SEA Modernization Starter Kit Rectification.postman_collection.json
@@ -8,6 +8,60 @@
 		{
 			"name": "Get Existing Schools",
 			"item": [
+				{
+					"name": "Get  LEA",
+					"event": [
+						{
+							"listen": "prerequest",
+							"script": {
+								"exec": [
+									""
+								],
+								"type": "text/javascript"
+							}
+						},
+						{
+							"listen": "test",
+							"script": {
+								"exec": [
+									"pm.test(\"Status code is 200\", () => {",
+									"    pm.expect(pm.response.code).to.equal(200);",
+									"});",
+									"const __ = require('lodash');",
+									"const leas = pm.response.json();",
+									"pm.environment.set(\"known:localEducationAgencyId\",__.first(leas)['localEducationAgencyId']);"
+								],
+								"type": "text/javascript"
+							}
+						}
+					],
+					"request": {
+						"method": "GET",
+						"header": [
+							{
+								"key": "Content-Type",
+								"name": "Content-Type",
+								"type": "text",
+								"value": "application/json"
+							}
+						],
+						"url": {
+							"raw": "{{ApiBaseUrl}}/data/v3/{{SchoolYear}}/ed-fi/localEducationAgencies",
+							"host": [
+								"{{ApiBaseUrl}}"
+							],
+							"path": [
+								"data",
+								"v3",
+								"{{SchoolYear}}",
+								"ed-fi",
+								"localEducationAgencies"
+							]
+						},
+						"description": "This api post method adds new academicWeeks for particular school .\nThis test method will throw WeekIdentifier is required error when WeekIdentifier is not passed"
+					},
+					"response": []
+				},
 				{
 					"name": "Get  School",
 					"event": [
@@ -29,8 +83,7 @@
 									"});",
 									"const __ = require('lodash');",
 									"const schools = pm.response.json();",
-									"pm.environment.set(\"known:schoolId\",__.first(schools)['schoolId']);",
-									"pm.environment.set(\"known:localEducationAgencyId\",__.first(schools)['localEducationAgencyReference'].localEducationAgencyId);"
+									"pm.environment.set(\"known:schoolId\",__.first(schools)['schoolId']);"
 								],
 								"type": "text/javascript"
 							}
@@ -47,7 +100,7 @@
 							}
 						],
 						"url": {
-							"raw": "{{ApiBaseUrl}}/data/v3/{{SchoolYear}}/ed-fi/schools/",
+							"raw": "{{ApiBaseUrl}}/data/v3/{{SchoolYear}}/ed-fi/schools?localEducationAgencyId=255901",
 							"host": [
 								"{{ApiBaseUrl}}"
 							],
@@ -56,8 +109,13 @@
 								"v3",
 								"{{SchoolYear}}",
 								"ed-fi",
-								"schools",
-								""
+								"schools"
+							],
+							"query": [
+								{
+									"key": "localEducationAgencyId",
+									"value": "255901"
+								}
 							]
 						},
 						"description": "This api post method adds new academicWeeks for particular school .\nThis test method will throw WeekIdentifier is required error when WeekIdentifier is not passed"

diff --git a/sample-api-calls/SEA Modernization Starter Kit.postman_collection.json b/sample-api-calls/SEA Modernization Starter Kit.postman_collection.json
@@ -9,7 +9,61 @@
 			"name": "Get Existing Schools",
 			"item": [
 				{
-					"name": "Get  School",
+					"name": "Get  LEA",
+					"event": [
+						{
+							"listen": "prerequest",
+							"script": {
+								"exec": [
+									""
+								],
+								"type": "text/javascript"
+							}
+						},
+						{
+							"listen": "test",
+							"script": {
+								"exec": [
+									"pm.test(\"Status code is 200\", () => {",
+									"    pm.expect(pm.response.code).to.equal(200);",
+									"});",
+									"const __ = require('lodash');",
+									"const leas = pm.response.json();",
+									"pm.environment.set(\"known:localEducationAgencyId\",__.first(leas)['localEducationAgencyId']);"
+								],
+								"type": "text/javascript"
+							}
+						}
+					],
+					"request": {
+						"method": "GET",
+						"header": [
+							{
+								"key": "Content-Type",
+								"name": "Content-Type",
+								"type": "text",
+								"value": "application/json"
+							}
+						],
+						"url": {
+							"raw": "{{ApiBaseUrl}}/data/v3/{{SchoolYear}}/ed-fi/localEducationAgencies",
+							"host": [
+								"{{ApiBaseUrl}}"
+							],
+							"path": [
+								"data",
+								"v3",
+								"{{SchoolYear}}",
+								"ed-fi",
+								"localEducationAgencies"
+							]
+						},
+						"description": "This api post method adds new academicWeeks for particular school .\nThis test method will throw WeekIdentifier is required error when WeekIdentifier is not passed"
+					},
+					"response": []
+				},
+				{
+					"name": "Get  School Copy",
 					"event": [
 						{
 							"listen": "prerequest",
@@ -29,8 +83,7 @@
 									"});",
 									"const __ = require('lodash');",
 									"const schools = pm.response.json();",
-									"pm.environment.set(\"known:schoolId\",__.first(schools)['schoolId']);",
-									"pm.environment.set(\"known:localEducationAgencyId\",__.first(schools)['localEducationAgencyReference'].localEducationAgencyId);"
+									"pm.environment.set(\"known:schoolId\",__.first(schools)['schoolId']);"
 								],
 								"type": "text/javascript"
 							}
@@ -47,7 +100,7 @@
 							}
 						],
 						"url": {
-							"raw": "{{ApiBaseUrl}}/data/v3/{{SchoolYear}}/ed-fi/schools/",
+							"raw": "{{ApiBaseUrl}}/data/v3/{{SchoolYear}}/ed-fi/schools?localEducationAgencyId={{known:localEducationAgencyId}}",
 							"host": [
 								"{{ApiBaseUrl}}"
 							],
@@ -56,8 +109,13 @@
 								"v3",
 								"{{SchoolYear}}",
 								"ed-fi",
-								"schools",
-								""
+								"schools"
+							],
+							"query": [
+								{
+									"key": "localEducationAgencyId",
+									"value": "{{known:localEducationAgencyId}}"
+								}
 							]
 						},
 						"description": "This api post method adds new academicWeeks for particular school .\nThis test method will throw WeekIdentifier is required error when WeekIdentifier is not passed"

diff --git a/sample-data/plugin/configuration.packages.json b/sample-data/plugin/configuration.packages.json
@@ -2,7 +2,7 @@
   "packages": {
     "sk": {
       "PackageName": "EdFi.Suite3.Ods.Extensions.SK",
-      "PackageVersion": "5.3.36",
+      "PackageVersion": "5.3.37",
       "PackageSource": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/nuget/v3/index.json"
     }
   }

diff --git a/sample-database-template/modules/create-sk-template.psm1 b/sample-database-template/modules/create-sk-template.psm1
@@ -13,7 +13,7 @@ function Get-SKConfiguration([hashtable] $config = @{ }) {
     $config = Merge-Hashtables (Get-DefaultTemplateConfiguration), $config
     $config.appSettings.Plugin.Folder = "$PSScriptRoot/../../../Ed-Fi-ODS-Implementation/plugin"
     $config.appSettings.Plugin.Scripts = @("sk")
-    $config.appSettings = Merge-Hashtables $config.appSettings, (Get-DefaultTemplateSettingsByEngine)[$config.engine]
+    $config.appSettings = Merge-Hashtables $config.appSettings, (Get-DefaultTPDMTemplateSettingsByEngine)[$config.engine]
 
     $config.testHarnessJsonConfigLEAs = @(255902, 255903)
     $config.testHarnessJsonConfig = "$PSScriptRoot/testHarnessConfiguration.SK.json"

diff --git a/...e-extension/EdFi.Ods.Extensions.Sk/Artifacts/MsSql/Data/Ods/0010-SampleExtensionsData.sql b/...e-extension/EdFi.Ods.Extensions.Sk/Artifacts/MsSql/Data/Ods/0010-SampleExtensionsData.sql
@@ -8,6 +8,6 @@ SELECT ssa.EntryDate, ssa.SchoolId, st.StudentUSI, sc.LocalEducationAgencyId, sc
 FROM edfi.Student st
 JOIN edfi.StudentSchoolAssociation ssa ON st.StudentUSI = ssa.StudentUSI
 JOIN edfi.School sc ON ssa.SchoolId = sc.SchoolId
-WHERE st.StudentUSI NOT IN (SELECT StudentUSI FROM sk.StudentSchoolAssociationExtension)
+WHERE st.StudentUSI NOT IN (SELECT StudentUSI FROM sk.StudentSchoolAssociationExtension) AND sc.LocalEducationAgencyId is NOT NULL
 
 GO
diff --git a/...e-extension/EdFi.Ods.Extensions.Sk/Artifacts/PgSql/Data/Ods/0010-SampleExtensionsData.sql b/...e-extension/EdFi.Ods.Extensions.Sk/Artifacts/PgSql/Data/Ods/0010-SampleExtensionsData.sql
@@ -7,6 +7,6 @@ SELECT ssa.EntryDate, ssa.SchoolId, st.StudentUSI, sc.LocalEducationAgencyId, sc
 FROM edfi.Student st
 JOIN edfi.StudentSchoolAssociation ssa ON st.StudentUSI = ssa.StudentUSI
 JOIN edfi.School sc ON ssa.SchoolId = sc.SchoolId
-WHERE st.StudentUSI NOT IN (SELECT StudentUSI FROM sk.StudentSchoolAssociationExtension)
+WHERE st.StudentUSI NOT IN (SELECT StudentUSI FROM sk.StudentSchoolAssociationExtension) AND sc.LocalEducationAgencyId is NOT NULL
 
 end $$;