test: add integration tests for OOTB connector templates

Co-authored-by: Maciej Barelkowski <[email protected]>

Author: 2 people

.github/workflows/INTEGRATION.yml

@@ -0,0 +1,22 @@
+name: INTEGRATION
+on: [ push, pull_request ]
+jobs:
+  Build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Use Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: 20
+        cache: 'npm'
+    - name: Install dependencies
+      run: npm ci
+    - name: Build
+      run: npm run build
+    - name: Fetch connector templates
+      run: npm run fetch:connector-templates
+    - name: Test
+      run: npm run test:integration

.gitignore

@@ -3,4 +3,5 @@ dist/
 coverage/
 .idea
 *.iml
-.DS_Store
+.DS_Store
+packages/**/test/integration/*.json

package.json

@@ -5,6 +5,7 @@
   "scripts": {
     "lint": "eslint packages",
     "test": "lerna run test",
+    "test:integration": "lerna run test:integration",
     "dev": "run-s build \"lerna-dev -- {@}\" -- ",
     "lerna-dev": "lerna run dev --stream --scope",
     "build": "lerna run build --parallel --stream",
@@ -16,7 +17,8 @@
     "lerna-publish:dry": "lerna version --no-git-tag-version --no-push",
     "release": "run-s build test lerna-publish",
     "release:alpha": "run-s build test lerna-publish:alpha",
-    "release:dry": "run-s build test lerna-publish:dry"
+    "release:dry": "run-s build test lerna-publish:dry",
+    "fetch:connector-templates": "node tasks/fetch-connector-templates.js" 
   },
   "repository": {
     "type": "git",

packages/zeebe-element-templates-json-schema/package.json

@@ -7,6 +7,7 @@
   ],
   "scripts": {
     "test": "mocha --reporter=spec --recursive test/spec",
+    "test:integration": "mocha --reporter=spec --recursive test/integration",
     "dev": "npm run test -- --watch",
     "all": "run-s build test",
     "build": "run-s build:error-messages build:schema",

packages/zeebe-element-templates-json-schema/test/integration/ootb-connector-templates-spec.js

@@ -0,0 +1,50 @@
+const { expect } = require('chai');
+
+const schema = require('../../resources/schema.json');
+
+const errorMessages = require('../../resources/error-messages.json');
+
+const {
+  createValidator
+} = require('../../../element-templates-json-schema-shared/test/helpers');
+
+const validator = createValidator(schema, errorMessages);
+
+const templates = require('./ootb-connector-templates.json');
+
+function validateTemplate(template) {
+
+  const valid = validator(template);
+
+  const errors = validator.errors;
+
+  return {
+    valid,
+    errors
+  };
+}
+
+describe('validation', function() {
+
+  templates.forEach(function(template) {
+
+    it(`should validate template <${ template.name }>`, async function() {
+
+      // when
+      const {
+        valid,
+        errors
+      } = validateTemplate(template);
+
+      if (!valid) {
+        console.error(`Validation errors for template <${ template.name }>:`, errors);
+      }
+
+      // then
+      expect(valid).to.be.true;
+      expect(errors).to.be.null;
+    });
+
+  });
+
+});

tasks/fetch-connector-templates.js

@@ -0,0 +1,78 @@
+/**
+ * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
+ * under one or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information regarding copyright
+ * ownership.
+ *
+ * Camunda licenses this file to you under the MIT; you may not use this file
+ * except in compliance with the MIT License.
+ */
+
+import { writeFileSync as writeFile } from 'fs';
+import { resolve as pathResolve } from 'path';
+
+const URL = 'https://marketplace.cloud.camunda.io/api/v1/ootb-connectors';
+
+const templates = await fetchTemplates();
+
+writeFile(
+  pathResolve('packages/zeebe-element-templates-json-schema/test/integration/ootb-connector-templates.json'),
+  JSON.stringify(templates, null, 2)
+);
+
+/**
+ * Fetch OOTB connector templates from the Camunda Marketplace.
+ *
+ * @returns {Promise<Template[]>} templates
+ */
+async function fetchTemplates() {
+  console.info('Fetching and updating templates');
+
+  let response = await fetch(URL);
+
+  if (!response.ok) {
+    console.warn(`Failed to fetch templates from ${ URL } (HTTP ${ response.status })`);
+
+    return [];
+  }
+
+  /** @type {TemplatesByIdMetadata} */
+  const templatesByIdMetadata = await response.json();
+
+  const tasks = [];
+
+  for (const id in templatesByIdMetadata) {
+    const templatesMetadata = templatesByIdMetadata[ id ];
+
+    for (const templateMetadata of templatesMetadata) {
+      tasks.push(fetchTemplate(templateMetadata, id));
+    }
+  }
+
+  return (await Promise.all(tasks)).filter(template => template !== null);
+}
+
+async function fetchTemplate(templateMetadata, id) {
+  const { ref } = templateMetadata;
+
+  const response = await fetch(ref);
+
+  if (!response.ok) {
+    console.warn(`Failed to fetch template ${ id } version ${ templateMetadata.version } from ${ ref } (HTTP ${ response.status })`);
+
+    return null;
+  }
+
+  try {
+    const templateText = await response.text();
+    let templateJson = JSON.parse(templateText);
+
+    console.info(`Fetched template ${ id } version ${ templateMetadata.version } from ${ ref }`);
+
+    return templateJson;
+  } catch (error) {
+    console.warn(`Failed to parse template ${ id } version ${ templateMetadata.version } fetched from ${ ref }`, error);
+
+    return null;
+  }
+}