TD-4455 test automation

.gitguardian.yaml

@@ -0,0 +1,5 @@
+secret:
+  ignored-matches:
+  - match: 2cd876d916d5d06984da35b99466857b4e9b19ab643b0e2eb15d4faf29f3ba44
+    name: Generic High Entropy Secret - DigitalLearningSolutions.Data.Migrations/202310131115_AddFreshdeskApikeyConfigValue.cs
+version: 2

.github/dependabot.yml

@@ -0,0 +1,40 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "nuget" 
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 10
+    target-branch: "Automatic_version_update_dependabot"
+    ignore:
+      # Ignore updates to packages that start with 'Wildcards'
+      - dependency-name: "Microsoft.FeatureManagement.AspNetCore*"
+      # Ignore some updates to the package
+      - dependency-name: "Microsoft.VisualStudio.Web.CodeGeneration.Design"
+        versions: [">7.0.0"]
+      - dependency-name: "Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation"
+        versions: [">7.0.0"]
+      - dependency-name: "Microsoft.AspNetCore.Mvc.Testing"
+        versions: [">7.0.0"]
+      - dependency-name: "Selenium.WebDriver.ChromeDriver"
+        versions: ">=113.0.5672.1278" # Recommended version
+      # For all packages, ignore all patch updates
+      #- dependency-name: "*"
+      #  update-types: ["version-update:semver-patch"]
+
+  # Configuration for npm
+  - package-ecosystem: "npm" 
+    directory: "/DigitalLearningSolutions.Web/" # Location of package manifests
+    schedule:
+      interval: "daily"
+    target-branch: "Automatic_version_update_dependabot"
+    #  - "dependencies"
+    open-pull-requests-limit: 7
+    ignore:
+      - dependency-name: "*"
+        update-types: ["version-update:semver-major"]

.github/pull_request_template.md

@@ -1,5 +1,5 @@
 ### JIRA link
-_HEEDLS-XXXX_
+_DLSV2-XXXX_
 
 ### Description
 _Describe what has changed and how that will affect the app. If relevant, add references to the resources you used. Use this as your opportunity to highlight anything odd and give people context around particular decisions._
@@ -12,10 +12,11 @@ _Attach screenshots on mobile, tablet and desktop._
 (Leave tasks unticked if they haven't been appropriate for your ticket.)
 
 I have:
-- [ ] Run the formatter and made sure there are no IDE errors.
+- [ ] Run the formatter and made sure there are no IDE errors (see [info on Text Editor settings](https://hee-tis.atlassian.net/wiki/spaces/TP/pages/3546185813/DLS+Dev+Process) to avoid whitespace changes)
 - [ ] Written tests for the changes (accessibility tests, unit tests for controller, data services, services, view models, etc)
-- [ ] Manually tested my work with and without JavaScript. Full manual testing guidelines can be found here: https://softwiretech.atlassian.net/wiki/spaces/HEE/pages/6703648740/Testing
-- [ ] Updated/added documentation in Swiki and/or Readme. Links (if any) are below:
+- [ ] Manually tested my work with and without JavaScript
+- [ ] Tested any Views or partials created or changed with [Wave Chrome plugin](https://chrome.google.com/webstore/detail/wave-evaluation-tool/jbbplnpkjmmeebjpijfedlgcdilocofh/related) and addressed any valid accessibility issues
+- [ ] Updated/added documentation in [Confluence](https://hee-tis.atlassian.net/wiki/spaces/TP/pages/3546939432/DLS+Code) and/or [GitHub Readme](https://github.com/TechnologyEnhancedLearning/DLSV2/blob/master/README.md). List of documentation links added/changed:
   - [doc_1_here](link_1_here)
-- [ ] Updated my Jira ticket with information about other parts of the system that were touched as part of the MR and have to be sanity tested to ensure nothing’s broken.
-- [ ] Scanned over my own MR to ensure everything is as expected.
+- [ ] Updated my Jira ticket with information about other parts of the system that were touched as part of the MR and have to be sanity tested to ensure nothing’s broken
+- [ ] Scanned over my pull request in GitHub and addressed any warnings from the GitHub Build and Test checks.

.github/workflows/build-and-deploy-dev.yml

@@ -0,0 +1,141 @@
+name: Deploy DLS DEV to IIS
+
+env: 
+    # set apppool and site name from IIS
+    AppPoolName : dlsweb-dev
+    SiteName  : 'dls-dev'
+    # set to site files.  In this case, the part of the path after E:/web/
+    SitePath :  dls-dev
+    DOTNET_INSTALL_DIR: '~/AppData/Local/Microsoft/dotnet'
+    DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
+on:
+      push:
+        branches: 
+        - 'DEV'
+      workflow_dispatch:
+
+jobs:
+  deploy-to-dev:
+
+    runs-on: self-hosted
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup .NET Core SDK 6.0
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 6.0.x
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Add TechnologyEnhancedLearning as nuget package source
+        run:  |
+                $nugetSources = dotnet nuget list source | Out-String;
+                if($nugetSources -like "*TechnologyEnhancedLearning*")
+                {
+                  # Update the source (in case PAT has been updated)
+                  dotnet nuget update source TechnologyEnhancedLearning --source https://pkgs.dev.azure.com/e-LfH/_packaging/LearningHubFeed/nuget/v3/index.json --username 'kevin.whittaker' --password ${{ secrets.AZURE_DEVOPS_PAT }} --store-password-in-clear-text
+                  } 
+                  else
+                  {
+                    # Add the source
+                    dotnet nuget add source https://pkgs.dev.azure.com/e-LfH/_packaging/LearningHubFeed/nuget/v3/index.json --name TechnologyEnhancedLearning --username 'kevin.whittaker' --password ${{ secrets.AZURE_DEVOPS_PAT }} --store-password-in-clear-text
+                    }
+      - name: Dotnet publish 
+        run: | 
+          dotnet publish DigitalLearningSolutions.sln -c Release -o E:/web/${{env.SitePath}}-NEW
+
+      - name: Copy app_offline and web config to publish folder
+        run: |
+          Copy-Item E:/web/Offline/app_offline.htm E:/web/${{env.SitePath}}-NEW -Recurse -Force;
+          Copy-Item E:/web/Offline/app_offline.htm E:/web/${{env.SitePath}} -Recurse -Force;
+          if (Test-Path -Path E:/web/${{env.SitePath}})
+          {
+            Remove-Item -Path 'E:/web/${{env.SitePath}}-NEW/web.config' -Force;
+            Copy-Item E:/web/${{env.SitePath}}/web.config E:/web/${{env.SitePath}}-NEW -Recurse -Force;
+          }
+          if (Test-Path -Path E:/web/${{env.SitePath}}-PREVIOUS){
+              Remove-Item -LiteralPath 'E:/web/${{env.SitePath}}-PREVIOUS' -Force -Recurse
+            }        
+
+      - name: Sleep for 5 seconds
+        run: Start-Sleep -s 5 
+
+      - name: Switch deployment and published folders restarting apppool/webapp if necessary
+        run: |
+
+          Import-Module WebAdministration; 
+          $currentRetry = 1;
+          $backupRetry = 1;
+          $success = $false;
+          $backupSuccess = $false;
+          do{
+            echo "Attempting folder rename $currentRetry"  
+            try {
+              Rename-Item -Path 'E:/web/${{env.SitePath}}' -NewName '${{env.SitePath}}-PREVIOUS' 
+              Rename-Item -Path 'E:/web/${{env.SitePath}}-NEW' -NewName '${{env.SitePath}}' 
+              $success = $true;
+            }
+            catch {
+              echo "Rename failed due to following Catch error:`n"
+              echo $PSItem.Exception.Message
+              echo "`n"
+              Start-Sleep -s 2
+              $currentRetry = $currentRetry + 1;
+            }
+            finally {
+              if ($currentRetry -ge 10) {
+                  echo "Rename keeps failing; restarting AppPool/Site as last resort`n"
+                  echo "Attempting to restart AppPool`n"
+                  do{
+                      $status = Get-WebAppPoolState -name '${{env.AppPoolName}}'
+                      if ($status.Value -eq "Stopped") {
+                          start-WebAppPool ${{env.AppPoolName}}
+                          echo "AppPool restarted`n---------`n"
+                          $backupSuccess = $true;
+                      }
+                      else {
+                          if ($backupRetry -ge 10) {
+                             throw "AppPool restart keeps failing."
+                          }
+                          echo "AppPool not stopped yet; Re-attempt #$backupRetry"
+                          Start-Sleep -s 10
+                          $backupRetry = $backupRetry + 1;
+                      }
+                  }
+                  while (!$backupSuccess -and $backupRetry -le 10)
+                  $backupRetry = 1;
+                  $backupSuccess = $false;
+                  echo "Attempting to restart Website`n"
+                  do{
+                      $status = Get-WebsiteState -name '${{env.SiteName}}'
+                      if ($status.Value -eq "Stopped") {
+                          start-iissite ${{env.SiteName}}
+                          echo "Website restarted`n---------`n"
+                          $backupSuccess = $true;
+                      }
+                      else {
+                          if ($backupRetry -ge 10) {
+                            throw "Website restart keeps failing. Please look into Server"
+                          }
+                          echo "Website not stopped yet; Re-attempt #$backupRetry"
+                          Start-Sleep -s 10
+                          $backupRetry = $backupRetry + 1;
+                      }
+                  }
+                  while (!$backupSuccess -and $backupRetry -le 10)
+              }
+            }
+          }
+          while (!$success -and $currentRetry -le 10) 
+
+      - name: Remove Offline and remove previous deployment folder
+        run: |
+         if (Test-Path -Path 'E:/web/${{env.SitePath}}-PREVIOUS')
+          {
+            Remove-Item -LiteralPath 'E:/web/${{env.SitePath}}-PREVIOUS' -Force -Recurse
+          }
+          Remove-Item 'E:/web/${{env.SitePath}}/app_offline.htm' -Force

.github/workflows/build-and-deploy-production.yml

@@ -0,0 +1,135 @@
+name: Deploy DLS Production to IIS
+
+env: 
+    # set apppool and site name from IIS
+    AppPoolName : dlsweb-v2
+    SiteName  : 'v2'
+    # set to site files.  In this case, the part of the path after E:/web/
+    SitePath :  dlsweb-v2
+    DOTNET_INSTALL_DIR: '~/AppData/Local/Microsoft/dotnet'
+    DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
+on:
+    workflow_dispatch:
+
+jobs:
+  deploy-to-production:
+
+    runs-on: self-hosted
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup .NET Core SDK 6.0
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 6.0.x
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Add TechnologyEnhancedLearning as nuget package source
+        run:  |
+                $nugetSources = dotnet nuget list source | Out-String;
+                if($nugetSources -like "*TechnologyEnhancedLearning*")
+                {
+                  # Update the source (in case PAT has been updated)
+                  dotnet nuget update source TechnologyEnhancedLearning --source https://pkgs.dev.azure.com/e-LfH/_packaging/LearningHubFeed/nuget/v3/index.json --username 'kevin.whittaker' --password ${{ secrets.AZURE_DEVOPS_PAT }} --store-password-in-clear-text
+                  }
+                  else
+                  {
+                    # Add the source
+                    dotnet nuget add source https://pkgs.dev.azure.com/e-LfH/_packaging/LearningHubFeed/nuget/v3/index.json --name TechnologyEnhancedLearning --username 'kevin.whittaker' --password ${{ secrets.AZURE_DEVOPS_PAT }} --store-password-in-clear-text
+                    }
+
+      - name: Dotnet publish 
+        run: | 
+          dotnet publish DigitalLearningSolutions.sln -c Release -o E:/web/${{env.SitePath}}-NEW
+
+      - name: Copy app_offline and web config to publish folder
+        run: |
+          Copy-Item E:/web/Offline/app_offline.htm E:/web/${{env.SitePath}}-NEW -Recurse -Force;
+          Copy-Item E:/web/Offline/app_offline.htm E:/web/${{env.SitePath}} -Recurse -Force;
+          if (Test-Path -Path E:/web/${{env.SitePath}})
+          {
+            Remove-Item -Path 'E:/web/${{env.SitePath}}-NEW/web.config' -Force;
+            Copy-Item E:/web/${{env.SitePath}}/web.config E:/web/${{env.SitePath}}-NEW -Recurse -Force;
+          }
+          if (Test-Path -Path E:/web/${{env.SitePath}}-PREVIOUS){
+              Remove-Item -LiteralPath 'E:/web/${{env.SitePath}}-PREVIOUS' -Force -Recurse
+            }        
+
+      - name: Sleep for 5 seconds
+        run: Start-Sleep -s 5 
+
+      - name: Switch deployment and published folders restarting apppool/webapp if necessary
+        run: |
+
+          Import-Module WebAdministration; 
+          $currentRetry = 1;
+          $backupRetry = 1;
+          $success = $false;
+          $backupSuccess = $false;
+          do{
+            echo "Attempting folder rename $currentRetry"  
+            try {
+              Rename-Item -Path 'E:/web/${{env.SitePath}}' -NewName '${{env.SitePath}}-PREVIOUS' 
+              Rename-Item -Path 'E:/web/${{env.SitePath}}-NEW' -NewName '${{env.SitePath}}' 
+              $success = $true;
+            }
+            catch {
+              echo "Rename failed due to following Catch error:`n"
+              echo $PSItem.Exception.Message
+              echo "`n"
+              Start-Sleep -s 2
+              $currentRetry = $currentRetry + 1;
+            }
+            finally {
+              if ($currentRetry -ge 10) {
+                  echo "Rename keeps failing; restarting AppPool/Site as last resort`n"
+                  echo "Attempting to restart AppPool`n"
+                  do{
+                      $status = Get-WebAppPoolState -name '${{env.AppPoolName}}'
+                      if ($status.Value -eq "Stopped") {
+                          start-WebAppPool ${{env.AppPoolName}}
+                          echo "AppPool restarted`n---------`n"
+                          $backupSuccess = $true;
+                      }
+                      else {
+                          if ($backupRetry -ge 10) {
+                             throw "AppPool restart keeps failing."
+                          }
+                          echo "AppPool not stopped yet; Re-attempt #$backupRetry"
+                          Start-Sleep -s 10
+                          $backupRetry = $backupRetry + 1;
+                      }
+                  }
+                  while (!$backupSuccess -and $backupRetry -le 10)
+                  $backupRetry = 1;
+                  $backupSuccess = $false;
+                  echo "Attempting to restart Website`n"
+                  do{
+                      $status = Get-WebsiteState -name '${{env.SiteName}}'
+                      if ($status.Value -eq "Stopped") {
+                          start-iissite ${{env.SiteName}}
+                          echo "Website restarted`n---------`n"
+                          $backupSuccess = $true;
+                      }
+                      else {
+                          if ($backupRetry -ge 10) {
+                            throw "Website restart keeps failing. Please look into Server"
+                          }
+                          echo "Website not stopped yet; Re-attempt #$backupRetry"
+                          Start-Sleep -s 10
+                          $backupRetry = $backupRetry + 1;
+                      }
+                  }
+                  while (!$backupSuccess -and $backupRetry -le 10)
+              }
+            }
+          }
+          while (!$success -and $currentRetry -le 10) 
+
+      - name: Remove Offline and remove previous deployment folder
+        run: |
+          Remove-Item 'E:/web/${{env.SitePath}}/app_offline.htm' -Force