0.1.0

.dockerignore

@@ -16,3 +16,4 @@ commitlint.config.json
 dist
 build
 reports
+devScripts

.github/workflows/pull_request.yaml

@@ -1,8 +1,196 @@
 name: pull_request
 
-on: [pull_request]
+on: [pull_request, workflow_dispatch]
 
 jobs:
-  pull_request:
-    uses: MapColonies/shared-workflows/.github/workflows/pull_request.yaml@master
-    secrets: inherit
+  eslint:
+    name: Run eslint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run linters
+        uses: wearerequired/lint-action@v1
+        with:
+          github_token: ${{ secrets.github_token }}
+          # Enable linters
+          eslint: true
+          prettier: true
+          eslint_extensions: ts
+
+      - name: OpenAPI Lint Checks
+        uses: nwestfall/openapi-action@v1.0.2
+        with:
+         github_token: ${{ secrets.GITHUB_TOKEN }}
+         file: ./openapi3.yaml
+
+  integration-test:
+      name: Run Integration Tests
+      runs-on: ubuntu-latest
+      container: node:16
+
+      services:
+        # Label used to access the service container
+        elasticsearch:
+          # Docker Hub image
+          image: elasticsearch:8.13.0
+          env:
+            discovery.type: single-node
+            xpack.security.enabled: false
+            xpack.security.enrollment.enabled: false
+            ES_JAVA_OPTS: "-Xms512m -Xmx512m"
+          ports:
+            - 9200:9200
+          # Set health checks to wait until elastic has started
+          options: >-
+            --health-cmd "curl -f http://localhost:9200/_cluster/health || exit 1"
+            --health-interval 10s
+            --health-timeout 5s
+            --health-retries 5
+
+        minio:
+          # Docker Hub image
+          image: minio/minio:edge-cicd
+          env:
+            MINIO_ROOT_USER: minio
+            MINIO_ROOT_PASSWORD: minio123
+          ports:
+            - 9000:9000
+          # Set health checks to wait until elastic has started
+          options: >-
+            --health-cmd "curl -f http://localhost:9000/minio/health/live || exit 1"
+            --health-interval 10s
+            --health-timeout 5s
+            --health-retries 5
+
+      strategy:
+        matrix:
+          node: [18.x, 20.x]
+
+      steps:
+        - name: Check out Git repository
+          uses: actions/checkout@v2
+
+        - name: Set up Node.js
+          uses: actions/setup-node@v1
+          with:
+            node-version: ${{ matrix.node }}
+
+        - name: Install Node.js dependencies
+          run: npm ci
+
+        - name: Wait for Elasticsearch
+          run: |
+            until curl -s http://elasticsearch:9200/_cluster/health | grep '"status":"green"'; do
+              echo "Waiting for Elasticsearch...";
+              sleep 5;
+            done
+
+        - name: Run integration tests
+          run: npm run test:integration
+
+        - uses: actions/upload-artifact@v4
+          with:
+            name: Test Reporters
+            path: reports/**
+
+  unit-test:
+      name: Run Unit Tests
+      runs-on: ubuntu-latest
+      container: node:16
+
+      services:
+        # Label used to access the service container
+        elasticsearch:
+          # Docker Hub image
+          image: elasticsearch:8.13.0
+          env:
+            discovery.type: single-node
+            xpack.security.enabled: false
+            xpack.security.enrollment.enabled: false
+            ES_JAVA_OPTS: "-Xms512m -Xmx512m"
+          ports:
+            - 9200:9200
+          # Set health checks to wait until elastic has started
+          options: >-
+            --health-cmd "curl -f http://localhost:9200/_cluster/health || exit 1"
+            --health-interval 10s
+            --health-timeout 5s
+            --health-retries 5
+
+        minio:
+          # Docker Hub image
+          image: minio/minio:edge-cicd
+          env:
+            MINIO_ROOT_USER: minio
+            MINIO_ROOT_PASSWORD: minio123
+          ports:
+            - 9000:9000
+          # Set health checks to wait until elastic has started
+          options: >-
+            --health-cmd "curl -f http://localhost:9000/minio/health/live || exit 1"
+            --health-interval 10s
+            --health-timeout 5s
+            --health-retries 5
+
+      strategy:
+        matrix:
+          node: [18.x, 20.x]
+
+      steps:
+        - name: Check out Git repository
+          uses: actions/checkout@v2
+
+        - name: Set up Node.js
+          uses: actions/setup-node@v1
+          with:
+            node-version: ${{ matrix.node }}
+
+        - name: Install Node.js dependencies
+          run: npm ci
+
+        - name: Wait for Elasticsearch
+          run: |
+            until curl -s http://elasticsearch:9200/_cluster/health | grep '"status":"green"'; do
+              echo "Waiting for Elasticsearch...";
+              sleep 5;
+            done
+
+        - name: Run unit tests
+          run: npm run test:unit
+
+        - uses: actions/upload-artifact@v4
+          with:
+            name: Test Reporters
+            path: reports/**
+
+  security:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Run Snyk to check for vulnerabilities
+      uses: snyk/actions/node@master
+      continue-on-error: true
+      env:
+        SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
+
+  build_image:
+    name: Build Image
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v2
+
+      - name: build Docker image
+        run: docker build -t test-build:latest .

config/custom-environment-variables.json

@@ -67,25 +67,39 @@
         }
       }
     },
-    "postgresql": {
-      "host": "POSTGRES_URL",
+    "s3": {
+      "endpoint": "S3_ENDPOINT",
+      "credentials": {
+        "accessKeyId": "S3_ACCESS_KEY",
+        "secretAccessKey": "S3_SECRET_KEY"
+      },
+      "region": "S3_REGION",
+      "files": {
+        "__name": "S3_FILES_DATA",
+        "__format": "json"
+      }
+    },
+    "redis": {
+      "host": "REDIS_HOST",
       "port": {
-        "__name": "POSTGRES_PORT",
+        "__name": "REDIS_PORT",
         "__format": "number"
       },
-      "username": "POSTGRES_USERNAME",
-      "password": "POSTGRES_PASSWORD",
+      "username": "REDIS_USERNAME",
+      "password": "REDIS_PASSWORD",
       "enableSslAuth": {
-        "__name": "POSTGRES_ENABLE_SLL_AUTH",
+        "__name": "REDIS_ENABLE_SSL_AUTH",
         "__format": "boolean"
       },
       "sslPaths": {
-        "ca": "POSTGRES_CA_PATH",
-        "key": "POSTGRES_KEY_PATH",
-        "cert": "POSTGRES_CERT_PATH"
+        "ca": "REDIS_CA_PATH",
+        "key": "REDIS_KEY_PATH",
+        "cert": "REDIS_CERT_PATH"
       },
-      "database": "POSTGRES_DB_NAME",
-      "schema": "POSTGRES_DB_SCHEMA"
+      "database": {
+        "__name": "REDIS_DATABASE",
+        "__format": "number"
+      }
     }
   },
   "application": {
@@ -104,6 +118,11 @@
       "__name": "NAME_TRANSLATION_KEYS",
       "__format": "json"
     },
-    "mainLanguageRegex": "MAIN_LANGUAGE_REGEX"
+    "controlObjectDisplayNamePrefixes": {
+      "__name": "CONTROL_DISPLAY_KEY_TRANSLATIONS",
+      "__format": "json"
+    },
+    "mainLanguageRegex": "MAIN_LANGUAGE_REGEX",
+    "site": "SITE"
   }
 }

config/default.json

@@ -28,22 +28,21 @@
   "db": {
     "elastic": {
       "control": {
-        "node": "http://localhost:9200",
+        "node": "http://control_elastic:9200",
         "auth": {
-          "username": "control",
-          "password": "password"
+          "username": "elastic",
+          "password": "changeme"
         },
         "requestTimeout": 60000,
         "properties": {
-          "index": "control_index",
-          "defaultResponseLimit": 3
+          "index": "control_index"
         }
       },
       "geotext": {
-        "node": "http://localhost:9200",
+        "node": "http://geotext_elastic:9200",
         "auth": {
-          "username": "geotext",
-          "password": "password"
+          "username": "elastic",
+          "password": "changeme"
         },
         "requestTimeout": 60000,
         "properties": {
@@ -52,25 +51,37 @@
             "placetypes": "placetypes_index",
             "hierarchies": "hierarchies_index"
           },
-          "defaultResponseLimit": 3,
           "textTermLanguage": "en"
         }
       }
     },
-    "postgresql": {
-      "type": "postgres",
-      "host": "localhost",
-      "port": 5432,
-      "username": "postgres",
-      "password": "postgres",
+    "s3": {
+      "endpoint": "http://s3:9000",
+      "credentials": {
+        "accessKeyId": "accessKeyId",
+        "secretAccessKey": "secretAccessKey"
+      },
+      "forcePathStyle": true,
+      "region": "local",
+      "files": {
+        "latLonConvertionTable": {
+          "bucket": "geocoding",
+          "fileName": "table.json"
+        }
+      }
+    },
+    "redis": {
+      "host": "REDIS_HOST",
+      "port": 6379,
+      "username": "",
+      "password": "",
       "enableSslAuth": false,
       "sslPaths": {
         "ca": "",
         "key": "",
         "cert": ""
       },
-      "database": "postgres",
-      "schema": "geocoder"
+      "database": 0
     }
   },
   "application": {
@@ -85,12 +96,10 @@
       "hierarchy": 1.1,
       "viewbox": 1.1
     },
-    "sources": {
-      "SOURCE_A": "a",
-      "SOURCE_B": "b"
-    },
+    "sources": {},
     "regions": {},
-    "nameTranslationsKeys": ["en", "fr"],
+    "controlObjectDisplayNamePrefixes": {},
+    "nameTranslationsKeys": [],
     "mainLanguageRegex": "[a-zA-Z]"
   }
 }