Advanced harness suite test

.github/workflows/ci.yml

@@ -87,7 +87,7 @@ jobs:
             ~/.m2/repository/org/liquibase/
 
       - name: Run Tests
-        run: mvn -B jacoco:prepare-agent surefire:test -DfailIfNoTests=true
+        run: mvn -B jacoco:prepare-agent surefire:test -Dtest="RedshiftDatabaseTest" -DfailIfNoTests=true
 
       - name: Archive Test Results
         if: ${{ always() }}
@@ -98,43 +98,48 @@ jobs:
             **/target/surefire-reports
             **/target/jacoco.exec
 
-#  integration-test:
-#    name: Test Harness for Redshift ${{ matrix.redshift }}
-#    needs: build
-#    runs-on: ubuntu-latest
-#
-#    strategy:
-#      fail-fast: false
-#      matrix:
-#        redshift: [ "" ]
-#
-#    steps:
-#      - uses: actions/checkout@v2
-#
-#      - name: Set up JDK
-#        uses: actions/setup-java@v2
-#        with:
-#          java-version: 17
-#          distribution: 'temurin'
-#          cache: 'maven'
-#
-#      - name: Build Cache
-#        uses: actions/cache@v3.0.5
-#        with:
-#          key: build-${{ github.run_number }}-${{ github.run_attempt }}
-#          path: |
-#            **/target/**
-#            ~/.m2/repository/org/liquibase/
-#
+  integration-test:
+    name: Test Harness for Redshift ${{ matrix.redshift }}
+    needs: build
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        redshift: [ "" ]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up JDK
+        uses: actions/setup-java@v2
+        with:
+          java-version: 17
+          distribution: 'temurin'
+          cache: 'maven'
+
+      - name: Build Cache
+        uses: actions/cache@v3.0.5
+        with:
+          key: build-${{ github.run_number }}-${{ github.run_attempt }}
+          path: |
+            **/target/**
+            ~/.m2/repository/org/liquibase/
+
 #      - name: Run Tests
 #        run: mvn -B jacoco:prepare-agent surefire:test -Dredshift.version=${{ matrix.redshift }}
-#
-#      - name: Archive Test Results
-#        if: ${{ always() }}
-#        uses: actions/upload-artifact@v2
-#        with:
-#          name: test-reports-redshift-${{ matrix.redshift }}
-#          path: |
-#            **/target/surefire-reports
-#            **/target/jacoco.exec
+
+      - name: Advanced Harness Test Run
+#        env:
+#          LIQUIBASE_PRO_LICENSE_KEY: ${{ secrets.PRO_LICENSE_KEY }}
+        run: mvn -Dtest="LiquibaseHarnessFoundationalSuiteTest" -DdbName=redshift -DdbUsername=${{secrets.TH_DB_ADMIN}} -DdbPassword=${{secrets.TH_DB_PASSWD}} -DdbUrl=${{secrets.TH_REDSHIFTURL}} test
+
+      - name: Archive Test Results
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v2
+        with:
+          name: test-reports-redshift-${{ matrix.redshift }}
+          path: |
+            **/target/surefire-reports
+            **/target/jacoco.exec
 

README.test-harness.md

@@ -18,5 +18,22 @@ Redshift specific change objects tests created exclusively to test this extensio
 `src/test/resources/liquibase/harness/changelogs/redshift` directory. If the directory does not already exist, please create
     it and add the test files that you would like tested).
 
+#### Executing the Harness Advanced test
+- From your IDE, right click on the `LiquibaseHarnessAdvancedSuiteTest` test class present in `src/test/groovy/liquibase/ext/redshift` directory.
+    - Doing so, will allow you to execute Advanced harness suite, which includes GenerateChangelog and Snapshot tests. Test data for these tests will be located in the
+      `src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/redshift` and `src/main/resources/liquibase/harness/snapshot/changelogs(expectedSnapshot)/redshift`directories.
+    - If the directories do not already exist, please create them and add the test data files that you would like to be tested.
+
+#### Executing the Harness Foundational test
+- From your IDE, right click on the `LiquibaseHarnessFoundationalSuiteTest` test class present in `src/test/groovy/liquibase/ext/redshift` directory.
+    - Doing so, will allow you to execute Foundational harness suite. Test data for this test will be located in the
+      `src/test/resources/liquibase/harness/compatibility/foundational/expectedResultSet/redshift` directory.
+    - If the directory does not already exist, please create it and add the test data files that you would like to be tested.
+
+##### Alternative ways to run the Harness test suites
+- Using maven by executing next command:
+  mvn -Dtest="TESTSUITE_NAME" -DdbName=redshift -DdbUsername=USERNAME -DdbPassword=PASSWORD -DdbUrl=URL test
+    - where USERNAME, PASSWORD and URL are connection credentials and TESTSUITE_NAME is the name of test suite you want to execute (LiquibaseHarnessAdvancedSuiteTest, LiquibaseHarnessFoundationalSuiteTest)
+
 #### Troubleshooting notes
 - If your IDE doesn't allow you to run LiquibaseHarnessSuiteIT as a test class, mark test/groovy folder as test classes folder in your IDE

pom.xml

@@ -92,6 +92,11 @@
             <artifactId>liquibase-core</artifactId>
             <version>${liquibase.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.liquibase</groupId>
+            <artifactId>liquibase-commercial</artifactId>
+            <version>${liquibase.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.spockframework</groupId>
             <artifactId>spock-core</artifactId>
@@ -107,9 +112,19 @@
         <dependency>
             <groupId>org.liquibase</groupId>
             <artifactId>liquibase-test-harness</artifactId>
-            <version>1.0.8</version>
+            <version>1.0.9</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.yaml</groupId>
+            <artifactId>snakeyaml</artifactId>
+            <version>1.33</version>
+        </dependency>
+        <dependency>
+            <groupId>org.skyscreamer</groupId>
+            <artifactId>jsonassert</artifactId>
+            <version>1.5.1</version>
+        </dependency>
         <dependency>
             <groupId>com.amazon.redshift</groupId>
             <artifactId>redshift-jdbc42</artifactId>

src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/redshift/addForeignKeyConstraint.sql

@@ -0,0 +1,7 @@
+CREATE TABLE "test_table_reference" ("id" INTEGER NOT NULL, "test_column" INTEGER NOT NULL, CONSTRAINT "test_table_reference_pkey" PRIMARY KEY ("id"));
+
+ALTER TABLE "test_table_reference" ADD CONSTRAINT "test_table_reference_test_column_key" UNIQUE ("test_column");
+
+CREATE TABLE "test_table_base" ("id" INTEGER NOT NULL, CONSTRAINT "test_table_base_pkey" PRIMARY KEY ("id"));
+
+ALTER TABLE "test_table_base" ADD CONSTRAINT "test_fk" FOREIGN KEY ("id") REFERENCES "test_table_reference" ("test_column") ON UPDATE RESTRICT ON DELETE CASCADE;

src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/redshift/addForeignKeyConstraint.xml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog
+        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+         http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+    <changeSet id="1" author="as">
+        <createTable tableName="test_table_base">
+            <column name="id" type="INT">
+                <constraints nullable="false" primaryKey="true"/>
+            </column>
+        </createTable>
+        <rollback>
+            <dropTable tableName="test_table_base"/>
+        </rollback>
+    </changeSet>
+    <changeSet id="2" author="as">
+        <createTable tableName="test_table_reference">
+            <column name="id" type="INT">
+                <constraints nullable="false" primaryKey="true"/>
+            </column>
+            <column name="test_column" type="INT">
+                <constraints nullable="false" unique="true"/>
+            </column>
+        </createTable>
+        <rollback>
+            <dropTable tableName="test_table_reference"/>
+        </rollback>
+    </changeSet>
+    <changeSet id="4" author="as">
+        <addForeignKeyConstraint  baseColumnNames="id"
+                                  baseTableName="test_table_base"
+                                  constraintName="test_fk"
+                                  referencedColumnNames="test_column"
+                                  referencedTableName="test_table_reference"
+                                  validate="true"/>
+        <rollback>
+            <dropForeignKeyConstraint baseTableName="test_table_base"
+                                      constraintName="test_fk"/>
+        </rollback>
+    </changeSet>
+</databaseChangeLog>

src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/redshift/column.sql

@@ -0,0 +1 @@
+CREATE TABLE "test_table" ("test_column" INTEGER, "varcharColumn" VARCHAR(25), "intColumn" INTEGER, "dateColumn" date);

src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/redshift/column.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog
+        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+         http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+    <changeSet id="1" author="as">
+        <createTable tableName="test_table">
+            <column name="test_column" type="INT"/>
+        </createTable>
+        <rollback/>
+    </changeSet>
+    <changeSet id="2" author="as">
+        <addColumn tableName="test_table">
+            <column name="varcharColumn" type="varchar(25)" value="INITIAL_VALUE"/>
+            <column name="intColumn" type="int" valueNumeric="5"/>
+            <column name="dateColumn" type="date" valueDate="2020-09-21"/>
+        </addColumn>
+        <rollback>
+            <dropTable tableName="test_table"/>
+        </rollback>
+    </changeSet>
+</databaseChangeLog>

src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/redshift/createTable.sql

@@ -0,0 +1 @@
+CREATE TABLE "test_table_xml" ("test_column" INTEGER);

src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/redshift/createView.sql

@@ -0,0 +1,5 @@
+CREATE VIEW "test_view" AS SELECT authors.id,
+    authors.first_name,
+    authors.last_name,
+    authors.email
+   FROM authors;;

src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/redshift/createView.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog
+        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+         http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+    <changeSet id="1" author="as">
+        <createTable tableName="view_test_table">
+            <column name="test_column" type="INT"/>
+        </createTable>
+        <rollback>
+            <dropTable tableName="view_test_table"/>
+        </rollback>
+    </changeSet>
+    <changeSet id="2" author="as">
+        <createView viewName="test_view">
+            select test_column from view_test_table
+        </createView>
+        <rollback>
+            <dropView viewName="test_view"/>
+        </rollback>
+    </changeSet>
+</databaseChangeLog>

src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/redshift/primary.sql

@@ -0,0 +1 @@
+CREATE TABLE "test_table" ("id" INTEGER NOT NULL, CONSTRAINT "test_pk" PRIMARY KEY ("id"));

src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/redshift/primary.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog
+        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+         http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+    <changeSet id="1" author="as">
+        <createTable tableName="test_table">
+            <column name="id" type="INT">
+                <constraints nullable="false"/>
+            </column>
+        </createTable>
+        <rollback>
+            <dropTable tableName="test_table"/>
+        </rollback>
+    </changeSet>
+    <changeSet id="2" author="as">
+        <addPrimaryKey
+                columnNames="id"
+                constraintName="test_pk"
+                tableName="test_table"
+                validate="true"/>
+        <rollback>
+            <dropPrimaryKey tableName="test_table"
+                            constraintName="test_pk"/>
+        </rollback>
+    </changeSet>
+</databaseChangeLog>

src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/redshift/unique.sql

@@ -0,0 +1,3 @@
+CREATE TABLE "test_table" ("id" INTEGER);
+
+ALTER TABLE "test_table" ADD CONSTRAINT "test_unique_constraint" UNIQUE ("id");

src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/redshift/unique.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog
+        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+         http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+    <changeSet id="1" author="as">
+        <createTable tableName="test_table">
+            <column name="id" type="INT"/>
+        </createTable>
+        <rollback>
+            <dropTable tableName="test_table"/>
+        </rollback>
+    </changeSet>
+    <changeSet id="2" author="as">
+        <addUniqueConstraint columnNames="id"
+                             constraintName="test_unique_constraint"
+                             tableName="test_table"
+                             validate="true"/>
+        <rollback>
+            <dropUniqueConstraint tableName="test_table"
+                                  constraintName="test_unique_constraint"/>
+        </rollback>
+    </changeSet>
+</databaseChangeLog>

src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/temp/addCheckConstraint.sql

@@ -0,0 +1 @@
+ALTER TABLE "posts" ADD CONSTRAINT "test_check_constraint" CHECK (((id > 0)));

src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/temp/addCheckConstraint.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog
+        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+        xmlns:pro="http://www.liquibase.org/xml/ns/pro"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+        http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+    <changeSet  id="1" author="as">
+        <pro:addCheckConstraint constraintName="test_check_constraint"
+                                 disabled="false"
+                                 tableName="posts"
+                                 validate="true">id > 0</pro:addCheckConstraint>
+    </changeSet>
+</databaseChangeLog>

src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/temp/createFunction.sql

@@ -0,0 +1,9 @@
+CREATE OR REPLACE FUNCTION "public".test_function()
+ RETURNS trigger
+ LANGUAGE plpgsql
+AS $function$
+      BEGIN
+      RAISE NOTICE 'Test function created';
+      RETURN NEW;
+      END;
+      $function$;

src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/temp/createFunction.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog
+  xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+  xmlns:pro="http://www.liquibase.org/xml/ns/pro"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+         http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+  <changeSet author="as" id="1">
+    <pro:createFunction
+      encoding="UTF-8"
+      functionName="test_function">CREATE OR REPLACE FUNCTION test_function()
+      RETURNS trigger
+      STABLE
+      AS $$
+      BEGIN
+      RAISE NOTICE 'Test function created';
+      RETURN NEW;
+      END;
+      $$
+      LANGUAGE sql;
+    </pro:createFunction>
+    <rollback>
+      <pro:dropFunction functionName="test_function"/>
+    </rollback>
+  </changeSet>
+</databaseChangeLog>

src/main/resources/liquibase/harness/generateChangelog/expectedChangeLog/temp/createPackage.sql

@@ -0,0 +1 @@
+INVALID TEST