lint mt ocp template and check db version matches (#2074)

Author: Fabian Martinez

.github/scripts/install-tools.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+npm install -g @stoplight/spectral-cli

.github/workflows/lint.yaml

@@ -0,0 +1,31 @@
+name: Linting Workflow
+on:
+  push:
+    paths-ignore:
+      - '.gitignore'
+      - 'LICENSE'
+      - 'README*'
+      - 'docs/**'
+    branches: [master]
+  pull_request:
+    paths-ignore:
+      - '.gitignore'
+      - 'LICENSE'
+      - 'README*'
+      - 'docs/**'
+    branches: [master, 2.0.x]
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-18.04
+    if: github.repository_owner == 'Apicurio'
+    steps:
+      - name: Checkout Code with Ref '${{ github.ref }}'
+        uses: actions/checkout@v2
+
+      - name: Install tools
+        run: .github/scripts/install-tools.sh
+
+      - name: Run linter
+        run: ./scripts/validate-files.sh

app/src/main/java/io/apicurio/registry/storage/impl/sql/AbstractSqlRegistryStorage.java

@@ -108,6 +108,7 @@
 import io.apicurio.registry.types.RuleType;
 import io.apicurio.registry.types.provider.ArtifactTypeUtilProvider;
 import io.apicurio.registry.types.provider.ArtifactTypeUtilProviderFactory;
+import io.apicurio.registry.utils.IoUtil;
 import io.apicurio.registry.utils.StringUtil;
 import io.apicurio.registry.utils.impexp.ArtifactRuleEntity;
 import io.apicurio.registry.utils.impexp.ArtifactVersionEntity;
@@ -125,7 +126,8 @@
  */
 public abstract class AbstractSqlRegistryStorage extends AbstractRegistryStorage {
 
-    private static int DB_VERSION = 5;
+    private static int DB_VERSION = Integer.valueOf(
+        IoUtil.toString(AbstractSqlRegistryStorage.class.getResourceAsStream("db-version"))).intValue();
     private static final Object dbMutex = new Object();
     private static final Object inmemorySequencesMutex = new Object();
 
@@ -230,6 +232,7 @@ private boolean isDatabaseInitialized(Handle handle) {
      */
     private boolean isDatabaseCurrent(Handle handle) {
         log.info("Checking to see if the DB is up-to-date.");
+        log.info("Build's DB version is {}", DB_VERSION);
         int version = this.getDatabaseVersion(handle);
         return version == DB_VERSION;
     }

app/src/main/resources/io/apicurio/registry/storage/impl/sql/db-version

@@ -0,0 +1 @@
+5

scripts/ocp-template-ruleset.js

@@ -0,0 +1,24 @@
+const seen = [];
+var notRepeated = function(value) {
+    if (seen.includes(value)) {
+      return [{
+        message: `Duplicated value '${value}'`
+      }];
+    } else {
+      seen.push(value);
+    }
+    return [];
+}
+
+module.exports = {
+  rules: {
+    "parameters-not-repeated": {
+      message: "{{error}}",
+      given: "$.parameters[*].name",
+      severity: "error",
+      then: {
+        function: notRepeated,
+      },
+    },
+  },
+};

scripts/validate-files.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+# DB_VERSION_BUILD=$(yq .project.properties."registry.sql.storage.db-version" app/pom.xml -r)
+DB_VERSION_BUILD=$(cat app/src/main/resources/io/apicurio/registry/storage/impl/sql/db-version)
+echo "Build's DB version is $DB_VERSION_BUILD"
+
+DDLS="app/src/main/resources/io/apicurio/registry/storage/impl/sql/postgresql.ddl app/src/main/resources/io/apicurio/registry/storage/impl/sql/h2.ddl"
+for ddl in $DDLS 
+do
+    echo "Processing DDL $ddl"
+    DB_VERSION_INSERT=$(grep "INSERT INTO apicurio (prop_name, prop_value) VALUES ('db_version'" $ddl)
+    DB_VERSION_IN_DDL=$(echo $DB_VERSION_INSERT | awk '{ print $8 }' - | awk -F ")" '{ print $1}' -)
+    echo "DB version in DDL is $DB_VERSION_IN_DDL"
+
+    if (( $(echo "$DB_VERSION_BUILD $DB_VERSION_IN_DDL" | awk '{print ($1 != $2)}') )); then
+        echo "DB version mismatch between DDL and build"
+        exit 1
+    fi
+done
+echo "DB version ok between build and DDLs"
+
+echo "Linting openshift templates"
+spectral lint distro/openshift-template/mt/apicurio-registry-mt-template.yaml --ruleset scripts/ocp-template-ruleset.js