Merge pull request #1209 from segovoni/unit-testing-tsqlt-docker/segovoni/enhancements

Improved workflow and sample description

Author: uc-msft

samples/containers/unit-testing/tsqlt-docker/.github/workflows/automated-tests.yml

@@ -1,6 +1,8 @@
-# This workflow installs tSQLt and runs the test units
+# This workflow runs the configured unit tests after installing tSQLt on a SQL Server instance inside a Docker container!
 
-name: tSQLt installer and unit testing runner
+name: Unit testing runner
+
+#---------- 1. Definition of activation events
 
 # Controls when the workflow will run
 on:
@@ -9,16 +11,21 @@ on:
     branches: [ "master" ]
   pull_request:
     branches: [ "master" ]
-    
+
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
+#---------- 2. Creating a Docker container from a SQL Server image on Linux
+
 jobs:
+
   windows-auth-tsqlt:
-    name: Installting tSQLt with SQL Auth
+
+    name: Installting tSQLt framework with SQL Auth and running unit tests
+
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
-    
+
     services:
       sqlserver:
         image: chriseaton/adventureworks:latest
@@ -29,63 +36,67 @@ jobs:
           SA_PASSWORD: 3uuiCaKxfbForrK
 
     steps:
-      - uses: actions/checkout@v2
 
-      - name: Install tSQLt with SQL auth on tempdb
-        uses: lowlydba/tsqlt-installer@v1
-        with:
-          sql-instance: localhost
-          database: tempdb
-          version: latest
-          user: sa
-          password: 3uuiCaKxfbForrK
-        
+#---------- 2.1 Save the container ID into the environment variable ENV_CONTAINER_ID
+
       #- name: Get the containers list unformatted
       #  run: docker ps
-  
+
       #- name: Get the containers list formatted
       #  run: docker ps --all --filter status=running --no-trunc --format "{{.ID}}"
-                
+
       #- name: Set the container ID
       #  run: echo '::set-output name=CONTAINER_ID::$(docker ps --all --filter status=running --no-trunc --format "{{.ID}}")'
       #  id: ContainerID
-        
+
       #- name: Get container ID
       #  run: echo "The container ID is ${{ steps.ContainerID.outputs.CONTAINER_ID }}"
-        
+
       - name: Set environment variable ENV_CONTAINER_ID
         run: echo "ENV_CONTAINER_ID=$(docker ps --all --filter status=running --no-trunc --format "{{.ID}}")" >> $GITHUB_ENV
 
       - name: Test environment variable ENV_CONTAINER_ID
         run: echo $ENV_CONTAINER_ID
-        
-      #- name: Print environment variables
-      #  run: env        
 
-      - name: Restore AdventureWorks2017
+      - name: Sleep for 20s
+        uses: juliangruber/sleep-action@v1
+        with:
+          time: 20s
+
+#---------- 3. AdventureWorks database recovery
+
+      - name: Restore AdventureWorks
         run: docker exec -i $ENV_CONTAINER_ID /opt/mssql-tools/bin/sqlcmd -S localhost -U SA -P "3uuiCaKxfbForrK" -Q "RESTORE DATABASE [AdventureWorks2017] FROM DISK = '/adventureworks.bak' WITH MOVE 'AdventureWorks2017' TO '/var/opt/mssql/data/AdventureWorks.mdf', MOVE 'AdventureWorks2017_log' TO '/var/opt/mssql/data/AdventureWorks_log.ldf'"
 
       - name: Get the database list
         run: docker exec -i $ENV_CONTAINER_ID /opt/mssql-tools/bin/sqlcmd -S localhost -U SA -P "3uuiCaKxfbForrK" -Q "SELECT Name FROM sys.databases"
 
+#---------- 4. Installation of the tSQLt framework
+
+      - uses: actions/checkout@v3.5.2
+
       - name: Install tSQLt with SQL auth on AdventureWorks2017
         uses: lowlydba/tsqlt-installer@v1
         with:
           sql-instance: localhost
           database: AdventureWorks2017
           version: latest
           user: sa
-          password: 3uuiCaKxfbForrK        
-        
+          password: 3uuiCaKxfbForrK
+
+#---------- 5. Creating the database objects to be tested (SUT)
+
       - name: Create sp usp_Raiserror_SafetyStockLevel
         run: docker exec -i $ENV_CONTAINER_ID /opt/mssql-tools/bin/sqlcmd -S localhost -U SA -P "3uuiCaKxfbForrK" -d AdventureWorks2017 -b < ./source/usp-raiserror-safetystocklevel.sql
-        
+
       - name: Create system under test (SUT) TR_Product_SafetyStockLevel
         run: docker exec -i $ENV_CONTAINER_ID /opt/mssql-tools/bin/sqlcmd -S localhost -U SA -P "3uuiCaKxfbForrK" -d AdventureWorks2017 -b < ./source/tr-product-safetystocklevel.sql
-        
+
+#---------- 6. Creation and execution of test units
+
       - name: Create test class UnitTestTRProductSafetyStockLevel
         run: docker exec -i $ENV_CONTAINER_ID /opt/mssql-tools/bin/sqlcmd -S localhost -U SA -P "3uuiCaKxfbForrK" -d AdventureWorks2017 -b < ./unit-test/test-class-trproductsafetystocklevel.sql
-        
+
       - name: Create and run test case try to insert one wrong row
         run: docker exec -i $ENV_CONTAINER_ID /opt/mssql-tools/bin/sqlcmd -S localhost -U SA -P "3uuiCaKxfbForrK" -d AdventureWorks2017 -b < ./unit-test/test-case-try-to-insert-one-wrong-row.sql
 

samples/containers/unit-testing/tsqlt-docker/README.md

@@ -95,7 +95,7 @@ on:
     branches: [ "master" ]
   pull_request:
     branches: [ "master" ]
-    
+
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 ```
@@ -112,8 +112,11 @@ The following YAML code snippet sets up the SQL Server service.
 
 ```
 jobs:
+
   windows-auth-tsqlt:
-    name: Installting tSQLt with SQL Auth
+
+    name: Installting tSQLt framework with SQL Auth and running unit tests
+
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
     
@@ -153,7 +156,7 @@ The snippet of YAML code used for the installation of the tSQLt framework in the
 
 ```
 steps:
-  - uses: actions/checkout@v2
+  - uses: actions/checkout@v3.5.2
   - name: Install tSQLt with SQL auth on AdventureWorks2017
     uses: lowlydba/tsqlt-installer@v1
     with:
@@ -177,8 +180,9 @@ Triggers and stored procedures are created in the AdventureWorks database attach
 ```
 - name: Create sp usp_Raiserror_SafetyStockLevel
   run: docker exec -i $ENV_CONTAINER_ID /opt/mssql-tools/bin/sqlcmd -S localhost -U SA -P "3uuiCaKxfbForrK" -d AdventureWorks2017 -b < ./source/usp-raiserror-safetystocklevel.sql
-- name: Create TR_Product_SafetyStockLevel
-  run: docker exec -i $ENV_CONTAINER_ID /opt/mssql-tools/bin/sqlcmd -S localhost -U SA -P "3uuiCaKxfbForrK" -d AdventureWorks2017 -b < ./source/tr_product_safetystocklevel.sql
+
+- name: Create system under test (SUT) TR_Product_SafetyStockLevel
+  run: docker exec -i $ENV_CONTAINER_ID /opt/mssql-tools/bin/sqlcmd -S localhost -U SA -P "3uuiCaKxfbForrK" -d AdventureWorks2017 -b < ./source/tr-product-safetystocklevel.sql
 ```
 
 **6. Creation and execution of test units**
@@ -203,10 +207,13 @@ The following snippet of YAML code creates and runs the test units.
 ```
 - name: Create and run test case try to insert one wrong row
   run: docker exec -i $ENV_CONTAINER_ID /opt/mssql-tools/bin/sqlcmd -S localhost -U SA -P "3uuiCaKxfbForrK" -d AdventureWorks2017 -b < ./unit-test/test-case-try-to-insert-one-wrong-row.sql
+
 - name: Create and run test case try to insert one right row
   run: docker exec -i $ENV_CONTAINER_ID /opt/mssql-tools/bin/sqlcmd -S localhost -U SA -P "3uuiCaKxfbForrK" -d AdventureWorks2017 -b < ./unit-test/test-case-try-to-insert-one-right-row.sql
+
 - name: Create and run test case try to insert multiple rows
   run: docker exec -i $ENV_CONTAINER_ID /opt/mssql-tools/bin/sqlcmd -S localhost -U SA -P "3uuiCaKxfbForrK" -d AdventureWorks2017 -b < ./unit-test/test-case-try-to-insert-multiple-rows.sql
+
 - name: Create and run test case try to insert multiple rows ordered
   run: docker exec -i $ENV_CONTAINER_ID /opt/mssql-tools/bin/sqlcmd -S localhost -U SA -P "3uuiCaKxfbForrK" -d AdventureWorks2017 -b < ./unit-test/test-case-try-to-insert-multiple-rows-ordered.sql
 ```