Add support for build and publish database project

.github/workflows/pr-check.yml

@@ -5,7 +5,7 @@ on:
 #     branches:
 #       - master
 #       - 'releases/*'
-      
+
 jobs:
     deploy:
       environment: Automation test
@@ -14,25 +14,43 @@ jobs:
         matrix:
           os: [windows-latest, ubuntu-latest]
       steps:
-      - name: Checkout from PR branch  
+      - name: Checkout from PR branch
         uses: actions/checkout@v2
-        with: 
+        with:
           repository: ${{ github.event.pull_request.head.repo.full_name }}
           ref: ${{ github.event.pull_request.head.ref }}
 
       - name: Installing node_modules
-        run: |
-          npm install
-
+        run: npm install
+
       - name: Build GitHub Action
         run: npm run build
 
-      - uses: azure/login@v1
+      - name: Azure Login
+        uses: azure/login@v1
         with:
           creds: ${{ secrets.AZURE_CREDENTIALS }}
-
-      - uses: ./
+
+      # Deploy a DACPAC with only a table to server
+      - name: Test DACPAC Action
+        uses: ./
+        with:
+          server-name: sql-action.database.windows.net
+          connection-string: ${{ secrets.AZURE_SQL_CONNECTION_STRING }}
+          dacpac-package: ./__testdata__/sql-action.dacpac
+
+      # Build and publish sqlproj that should create a new view
+      - name: Test Build and Publish
+        uses: ./
+        with:
+          server-name: sql-action.database.windows.net
+          connection-string: ${{ secrets.AZURE_SQL_CONNECTION_STRING }}
+          project-file: ./__testdata__/TestProject/sql-action.sqlproj
+
+      # Execute testsql.sql via SQLCMD on server
+      - name: Test SQL Action
+        uses: ./
         with:
           server-name: sql-action.database.windows.net
           connection-string: ${{ secrets.AZURE_SQL_CONNECTION_STRING }}
-          sql-file: ./testsql.sql
+          sql-file: ./__testdata__/testsql.sql

.gitignore

@@ -94,3 +94,7 @@ typings/
 /.vs/sql-action/v16/.suo
 /.vs/ProjectSettings.json
 /.vs/slnx.sqlite
+
+# Test sqlproj build artifacts
+/__testdata__/TestProject/bin/*
+/__testdata__/TestProject/obj/*

README.md

@@ -71,7 +71,7 @@ az ad sp create-for-rbac --name "mySQLServer" --role contributor \
 } 
 ```
 
-### Sample workflow to deploy to an Azure SQL database
+### Sample workflow to deploy a database project to an Azure SQL database
 
 ```yaml
 # .github/workflows/sql-deploy.yml
@@ -88,7 +88,33 @@ jobs:
     - uses: azure/sql-action@v1
       with:        
         server-name: REPLACE_THIS_WITH_YOUR_SQL_SERVER_NAME
-        connection-string: ${{ secrets.AZURE_SQL_CONNECTION_STRING }}
+        connection-string: ${{ secrets.AZURE_SQL_CONNECTION_STRING }}
+        project-file: './Database.sqlproj'
+        build-arguments: '-c Release'                 # Optional arguments passed to dotnet build
+        arguments: '/p:DropObjectsNotInSource=true'   # Optional parameters for SqlPackage Publish
+```
+
+**Note:**
+The database project must use the [Microsoft.Build.Sql](https://www.nuget.org/packages/microsoft.build.sql/) SDK.
+
+### Sample workflow to deploy a DACPAC to an Azure SQL database
+
+```yaml
+# .github/workflows/sql-deploy.yml
+on: [push]
+
+jobs:
+  build:
+    runs-on: windows-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: azure/login@v1
+      with:
+        creds: ${{ secrets.AZURE_CREDENTIALS }}
+    - uses: azure/sql-action@v1
+      with:
+        server-name: REPLACE_THIS_WITH_YOUR_SQL_SERVER_NAME
+        connection-string: ${{ secrets.AZURE_SQL_CONNECTION_STRING }}
         dacpac-package: './Database.dacpac'
 ```
 

__testdata__/TestProject/Table1.sql

@@ -0,0 +1,5 @@
+CREATE TABLE [dbo].[Table1]
+(
+  [Id] INT NOT NULL PRIMARY KEY,
+  [Column1] NVARCHAR(10) NULL
+)

__testdata__/TestProject/View1.sql

@@ -0,0 +1,2 @@
+CREATE VIEW [dbo].[View1]
+  AS SELECT * FROM [Table1]

__testdata__/TestProject/sql-action.sqlproj

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="Current">
+  <Sdk Name="Microsoft.Build.Sql" Version="0.1.1-alpha" />
+  <PropertyGroup>
+    <Name>sql-action</Name>
+    <DSP>Microsoft.Data.Tools.Schema.Sql.SqlAzureV12DatabaseSchemaProvider</DSP>
+    <ModelCollation>1033, CI</ModelCollation>
+  </PropertyGroup>
+</Project>

__testdata__/testsql.sql

@@ -0,0 +1,10 @@
+-- This script is used by pr-check.yml to test the SQLCMD action
+
+-- This should successfully insert data into the table created in the DACPAC step
+INSERT INTO [Table1] VALUES(1, 'test');
+
+-- This should successfully SELECT from the view created by the sqlproj
+SELECT * FROM [View1];
+
+-- Cleanup afterwards
+TRUNCATE TABLE [Table1];

__tests__/AzureSqlAction.test.ts

@@ -1,6 +1,8 @@
+import * as path from 'path';
 import * as exec from '@actions/exec';
-import AzureSqlAction, { IDacpacActionInputs, ISqlActionInputs, ActionType, SqlPackageAction } from "../src/AzureSqlAction";
+import AzureSqlAction, { IBuildAndPublishInputs, IDacpacActionInputs, ISqlActionInputs, ActionType, SqlPackageAction } from "../src/AzureSqlAction";
 import AzureSqlActionHelper from "../src/AzureSqlActionHelper";
+import DotnetUtils from '../src/DotnetUtils';
 import SqlConnectionStringBuilder from '../src/SqlConnectionStringBuilder';
 
 let sqlConnectionStringBuilderMock = jest.mock('../src/SqlConnectionStringBuilder', () => {
@@ -40,7 +42,7 @@ describe('AzureSqlAction tests', () => {
         let getSqlPackagePathSpy = jest.spyOn(AzureSqlActionHelper, 'getSqlPackagePath').mockResolvedValue('SqlPackage.exe');
         jest.spyOn(exec, 'exec').mockRejectedValue(1); 
 
-        expect(action.execute().catch(() => null)).rejects;
+        expect(await action.execute().catch(() => null)).rejects;
         expect(getSqlPackagePathSpy).toHaveBeenCalledTimes(1);
     });
 
@@ -66,9 +68,61 @@ describe('AzureSqlAction tests', () => {
         let getSqlCmdPathSpy = jest.spyOn(AzureSqlActionHelper, 'getSqlCmdPath').mockResolvedValue('SqlCmd.exe');
         jest.spyOn(exec, 'exec').mockRejectedValue(1);
 
-        expect(action.execute().catch(() => null)).rejects;
+        expect(await action.execute().catch(() => null)).rejects;
         expect(getSqlCmdPathSpy).toHaveBeenCalledTimes(1);
     });
+
+    it('should build and publish database project', async () => {
+        const inputs = getInputs(ActionType.BuildAndPublish) as IBuildAndPublishInputs;
+        const action = new AzureSqlAction(inputs);
+        const expectedDacpac = path.join('./bin/Debug', 'TestProject.dacpac');
+
+        const parseCommandArgumentsSpy = jest.spyOn(DotnetUtils, 'parseCommandArguments').mockResolvedValue({});
+        const findArgumentSpy = jest.spyOn(DotnetUtils, 'findArgument').mockResolvedValue(undefined);
+        const getSqlPackagePathSpy = jest.spyOn(AzureSqlActionHelper, 'getSqlPackagePath').mockResolvedValue('SqlPackage.exe');
+        const execSpy = jest.spyOn(exec, 'exec').mockResolvedValue(0);
+
+        await action.execute();
+
+        expect(parseCommandArgumentsSpy).toHaveBeenCalledTimes(1);
+        expect(findArgumentSpy).toHaveBeenCalledTimes(2);
+        expect(getSqlPackagePathSpy).toHaveBeenCalledTimes(1);
+        expect(execSpy).toHaveBeenCalledTimes(2);
+        expect(execSpy).toHaveBeenNthCalledWith(1, `dotnet build "./TestProject.sqlproj" -p:NetCoreBuild=true --verbose --test "test value"`);
+        expect(execSpy).toHaveBeenNthCalledWith(2, `"SqlPackage.exe" /Action:Publish /TargetConnectionString:"${inputs.connectionString.connectionString}" /SourceFile:"${expectedDacpac}"`);
+    });
+
+    it('throws if dotnet fails to build sqlproj', async () => {
+        const inputs = getInputs(ActionType.BuildAndPublish) as IBuildAndPublishInputs;
+        const action = new AzureSqlAction(inputs);
+
+        const parseCommandArgumentsSpy = jest.spyOn(DotnetUtils, 'parseCommandArguments').mockResolvedValue({});
+        jest.spyOn(exec, 'exec').mockRejectedValueOnce(1);
+
+        expect(await action.execute().catch(() => null)).rejects;
+        expect(parseCommandArgumentsSpy).toHaveBeenCalledTimes(1);
+    });
+
+    it('throws if build succeeds but fails to publish', async () => {
+        const inputs = getInputs(ActionType.BuildAndPublish) as IBuildAndPublishInputs;
+        const action = new AzureSqlAction(inputs);
+
+        const parseCommandArgumentsSpy = jest.spyOn(DotnetUtils, 'parseCommandArguments').mockResolvedValue({});
+        const getSqlPackagePathSpy = jest.spyOn(AzureSqlActionHelper, 'getSqlPackagePath').mockResolvedValue('SqlPackage.exe');
+        const execSpy = jest.spyOn(exec, 'exec').mockImplementation((commandLine) => {
+            // Mock implementation where dotnet build is successful but fails the SqlPackage publish 
+            if (commandLine.indexOf('dotnet build') >= 0) {
+                return Promise.resolve(0);
+            } else {
+                return Promise.reject(1);
+            }
+        });
+
+        expect(await action.execute().catch(() => null)).rejects;
+        expect(parseCommandArgumentsSpy).toHaveBeenCalledTimes(1);
+        expect(getSqlPackagePathSpy).toHaveBeenCalledTimes(1);  // Verify build succeeds and calls into Publish
+        expect(execSpy).toHaveBeenCalledTimes(2);
+    });
 });
 
 function getInputs(actionType: ActionType) {
@@ -95,5 +149,14 @@ function getInputs(actionType: ActionType) {
                 additionalArguments: '-t 20'
             } as ISqlActionInputs;
         }
+        case ActionType.BuildAndPublish: {
+            return {
+                serverName: 'testServer.database.windows.net',
+                actionType: ActionType.BuildAndPublish,
+                connectionString: new SqlConnectionStringBuilder('Server=testServer.database.windows.net;Initial Catalog=testDB;User Id=testUser;Password=testPassword'),
+                projectFile: './TestProject.sqlproj',
+                buildArguments: '--verbose --test "test value"'
+            } as IBuildAndPublishInputs
+        }
     }
 }

__tests__/DotnetUtils.test.ts

@@ -0,0 +1,34 @@
+import DotnetUtils from "../src/DotnetUtils";
+
+describe('DotnetUtils tests', () => {
+    it('parseCommandArguments should parse dotnet parameters', async () => {
+        let dotnetParams = '';
+        let parsedArgs = await DotnetUtils.parseCommandArguments(dotnetParams);
+        expect(parsedArgs).toEqual({});
+
+        dotnetParams = `-o C:\\test\\ --configuration 'Debug' --verbose --test "test value"`;
+        parsedArgs = await DotnetUtils.parseCommandArguments(dotnetParams);
+        expect(parsedArgs).toEqual({
+            '-o': 'C:\\test\\',
+            '--configuration': `'Debug'`,
+            '--verbose': undefined,
+            '--test': `"test value"`
+        });
+    });
+
+    it ('should find arguments parsed by parseCommandArguments', async () => {
+        const dotnetParams = `-o C:\\test\\ --configuration 'Debug' --verbose --test "test value"`;
+        const parsedArgs = await DotnetUtils.parseCommandArguments(dotnetParams);
+
+        expect(await DotnetUtils.findArgument(parsedArgs, '')).toEqual(undefined);
+        expect(await DotnetUtils.findArgument(parsedArgs, '-o')).toEqual('C:\\test\\');
+        expect(await DotnetUtils.findArgument(parsedArgs, '--output', '-o')).toEqual('C:\\test\\');
+        expect(await DotnetUtils.findArgument(parsedArgs, '--configuration', '-c')).toEqual(`'Debug'`);
+        expect(await DotnetUtils.findArgument(parsedArgs, '--verbose')).toEqual(undefined);
+        expect(await DotnetUtils.findArgument(parsedArgs, '--test')).toEqual(`"test value"`);
+
+        // Edge case
+        expect(await DotnetUtils.findArgument({}, '')).toEqual(undefined);
+    });
+
+});

__tests__/main.test.ts

@@ -20,6 +20,40 @@ describe('main.ts tests', () => {
         jest.restoreAllMocks();
     })
 
+    it('gets inputs and executes build and publish action', async () => {
+        const resolveFilePathSpy = jest.spyOn(AzureSqlActionHelper, 'resolveFilePath').mockReturnValue('./TestProject.sqlproj');
+        const getInputSpy = jest.spyOn(core, 'getInput').mockImplementation((name, options) => {
+            switch(name) {
+                case 'server-name': return 'test2.database.windows.net';
+                case 'connection-string': return 'Server=testServer.database.windows.net;Initial Catalog=testDB;User Id=testUser;Password=testPassword;';
+                case 'project-file': return './TestProject.sqlproj';
+                default : return '';
+            }
+        });
+
+        const getAuthorizerSpy = jest.spyOn(AuthorizerFactory, 'getAuthorizer');
+        const addFirewallRuleSpy = jest.spyOn(FirewallManager.prototype, 'addFirewallRule');
+        const actionExecuteSpy = jest.spyOn(AzureSqlAction.prototype, 'execute');
+        const removeFirewallRuleSpy = jest.spyOn(FirewallManager.prototype, 'removeFirewallRule');
+        const setFailedSpy = jest.spyOn(core, 'setFailed');
+        const detectIPAddressSpy = SqlUtils.detectIPAddress = jest.fn().mockImplementationOnce(() => {
+            return "";
+        });
+
+        await run();
+
+        expect(AzureSqlAction).toHaveBeenCalled();
+        expect(detectIPAddressSpy).toHaveBeenCalled();
+        expect(getAuthorizerSpy).not.toHaveBeenCalled();
+        expect(getInputSpy).toHaveBeenCalledTimes(7);
+        expect(SqlConnectionStringBuilder).toHaveBeenCalled();
+        expect(resolveFilePathSpy).toHaveBeenCalled();
+        expect(addFirewallRuleSpy).not.toHaveBeenCalled();
+        expect(actionExecuteSpy).toHaveBeenCalled();
+        expect(removeFirewallRuleSpy).not.toHaveBeenCalled();
+        expect(setFailedSpy).not.toHaveBeenCalled();
+    });
+
     it('gets inputs and executes dacpac action', async () => {
         let resolveFilePathSpy = jest.spyOn(AzureSqlActionHelper, 'resolveFilePath').mockReturnValue('./TestDacpacPackage.dacpac');
         let getInputSpy = jest.spyOn(core, 'getInput').mockImplementation((name, options) => {
@@ -30,7 +64,7 @@ describe('main.ts tests', () => {
             }
 
             return '';
-        }); 
+        });
 
         let getAuthorizerSpy = jest.spyOn(AuthorizerFactory, 'getAuthorizer');
         let addFirewallRuleSpy = jest.spyOn(FirewallManager.prototype, 'addFirewallRule');
@@ -64,7 +98,7 @@ describe('main.ts tests', () => {
                 case 'sql-file': return './TestSqlFile.sql';
                 default: return '';
             }
-        }); 
+        });
 
         let setFailedSpy = jest.spyOn(core, 'setFailed');
         let getAuthorizerSpy = jest.spyOn(AuthorizerFactory, 'getAuthorizer');
@@ -93,15 +127,15 @@ describe('main.ts tests', () => {
         jest.spyOn(AzureSqlActionHelper, 'resolveFilePath').mockImplementation(() => {
             throw new Error(`Unable to find file at location`);
         });
-        
+
         jest.spyOn(core, 'getInput').mockImplementation((name, options) => {
             switch(name) {
                 case 'server-name': return 'test1.database.windows.net';
                 case 'connection-string': return 'Server=testServer.database.windows.net;Initial Catalog=testDB;User Id=testUser;Password=testPassword;';
                 case 'sql-file': return './TestSqlFile.sql';
                 default: return '';
             }
-        }); 
+        });
         let detectIPAddressSpy = SqlUtils.detectIPAddress = jest.fn().mockImplementationOnce(() => {
             return "";
         });

action.yml

@@ -1,20 +1,26 @@
 name: 'Azure SQL Deploy'
-description: 'Deploy a DACPAC or a SQL script to Azure SQL database'
+description: 'Deploy a database project, DACPAC, or a SQL script to Azure SQL database'
 inputs:
   server-name:
-    description: 'Name of the Azure SQL Server name, like Fabrikam.database.windows.net.'
+    description: 'Name of the Azure SQL Server name, like Fabrikam.database.windows.net.'
     required: false
   connection-string:
-    description:  'The connection string, including authentication information, for the Azure SQL Server database.'
+    description:  'The connection string, including authentication information, for the Azure SQL Server database.'
     required: true
   dacpac-package:
-    description: 'Path to DACPAC file to deploy'
+    description: 'Path to DACPAC file to deploy'
     required: false
   sql-file:
-    description: 'Path to SQL script file to deploy'
+    description: 'Path to SQL script file to deploy'
+    required: false
+  project-file:
+    description: 'Path to the SQL database project file to deploy'
     required: false
   arguments:
-    description: 'In case DACPAC option is selected, additional SqlPackage arguments that will be applied. When SQL query option is selected, additional sqlcmd arguments will be applied.'
+    description: 'In case DACPAC option is selected, additional SqlPackage arguments that will be applied. When SQL query option is selected, additional sqlcmd arguments will be applied.'
+    required: false
+  build-arguments:
+    description: 'In case Build and Publish option is selected, additional arguments that will be applied to dotnet build when building the database project.'
     required: false
 runs:
   using: 'node12'