docker and workflow files

2025-12-12 15:25:49 +00:00 · 2023-02-07 23:34:11 +01:00 · 2023-02-07 23:34:11 +01:00 · 0d0d361358
commit 0d0d361358
parent 36e8e2c38d
5 changed files with 290 additions and 0 deletions
--- a/.github/workflows/test_federation.yml
+++ b/.github/workflows/test_federation.yml
@ -0,0 +1,98 @@
+name: gradido test_federation CI
+
+on: push
+
+jobs:
+  ##############################################################################
+  # JOB: DOCKER BUILD TEST #####################################################
+  ##############################################################################
+  build:
+    name: Docker Build Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      
+      - name: Build `test` image
+        run: |
+          docker build --target test -t "gradido/federation:test" -f federation/Dockerfile .
+          docker save "gradido/federation:test" > /tmp/federation.tar
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: docker-federation-test
+          path: /tmp/federation.tar
+
+  ##############################################################################
+  # JOB: LINT ##################################################################
+  ##############################################################################
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    needs: [build]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Download Docker Image
+        uses: actions/download-artifact@v3
+        with:
+          name: docker-federation-test
+          path: /tmp
+      - name: Load Docker Image
+        run: docker load < /tmp/federation.tar
+      
+      - name: Lint
+        run: docker run --rm gradido/federation:test yarn run lint
+
+  ##############################################################################
+  # JOB: UNIT TEST #############################################################
+  ##############################################################################
+  unit_test:
+    name: Unit tests
+    runs-on: ubuntu-latest
+    needs: [build]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      
+      - name: Download Docker Image
+        uses: actions/download-artifact@v3
+        with:
+          name: docker-federation-test
+          path: /tmp
+
+      - name: Load Docker Image
+        run: docker load < /tmp/federation.tar
+      
+      - name: docker-compose mariadb
+        run: docker-compose -f docker-compose.yml -f docker-compose.test.yml up --detach --no-deps mariadb
+      
+      - name: Sleep for 30 seconds
+        run: sleep 30s
+        shell: bash
+
+      - name: docker-compose database
+        run: docker-compose -f docker-compose.yml -f docker-compose.test.yml up --detach --no-deps database
+
+      - name: Sleep for 30 seconds
+        run: sleep 30s
+        shell: bash
+
+      #- name: Unit tests
+      #  run: cd database && yarn && yarn build && cd ../dht-node && yarn && yarn test
+      - name: Unit tests
+        run: |
+          docker run --env NODE_ENV=test --env DB_HOST=mariadb --network gradido_internal-net -v ~/coverage:/app/coverage --rm gradido/federation:test yarn run test
+          cp -r ~/coverage ./coverage
+          
+      - name: Coverage check
+        uses: webcraftmedia/coverage-check-action@master
+        with:
+          report_name: Coverage federation
+          type: lcov
+          #result_path: ./federation/coverage/lcov.info
+          result_path: ./coverage/lcov.info
+          min_coverage: 79
+          token: ${{ github.token }}
--- a/docker-compose.override.yml
+++ b/docker-compose.override.yml
@ -84,6 +84,29 @@ services:
      - ./dht-node:/app
      - ./database:/database

+  ########################################################
+  # FEDERATION ###########################################
+  ########################################################
+  federation:
+    # name the image so that it cannot be found in a DockerHub repository, otherwise it will not be built locally from the 'dockerfile' but pulled from there
+    image: gradido/federation:local-development
+    build:
+      target: development
+    networks:
+      - external-net
+      - internal-net
+    environment:
+      - NODE_ENV="development"
+    volumes:
+      # This makes sure the docker container has its own node modules.
+      # Therefore it is possible to have a different node version on the host machine
+      - federation_node_modules:/app/node_modules
+      - federation_database_node_modules:/database/node_modules
+      - federation_database_build:/database/build
+      # bind the local folder to the docker to allow live reload
+      - ./federation:/app
+      - ./database:/database
+
  ########################################################
  # DATABASE ##############################################
  ########################################################
@ -155,5 +178,8 @@ volumes:
  dht_node_modules:
  dht_database_node_modules:
  dht_database_build:
+  federation_node_modules:
+  federation_database_node_modules:
+  federation_database_build:
  database_node_modules:
  database_build:
--- a/docker-compose.test.yml
+++ b/docker-compose.test.yml
@ -36,6 +36,21 @@ services:
      - NODE_ENV="test"
      - DB_HOST=mariadb

+  ########################################################
+  # FEDERATION ###########################################
+  ########################################################
+  federation:
+    # name the image so that it cannot be found in a DockerHub repository, otherwise it will not be built locally from the 'dockerfile' but pulled from there
+    image: gradido/federation:test
+    build:
+      target: test
+    networks:
+      - external-net
+      - internal-net
+    environment:
+      - NODE_ENV="test"
+      - DB_HOST=mariadb
+
  ########################################################
  # DATABASE #############################################
  ########################################################
--- a/docker-compose.yml
+++ b/docker-compose.yml
@ -147,6 +147,42 @@ services:
      # <host_machine_directory>:<container_directory> – mirror bidirectional path in local context with path in Docker container
      - ./logs/dht-node:/logs/dht-node

+  ########################################################
+  # FEDERATION ###########################################
+  ########################################################
+  federation:
+    # name the image so that it cannot be found in a DockerHub repository, otherwise it will not be built locally from the 'dockerfile' but pulled from there
+    image: gradido/federation:local-production
+    build:
+      # since we have to include the entities from ./database we cannot define the context as ./federation
+      # this might blow build image size to the moon ?!
+      context: ./
+      dockerfile: ./federation/Dockerfile
+      target: production
+    networks:
+      - internal-net
+      - external-net
+    ports:
+      - 5000:5000
+    depends_on:
+      - mariadb
+    restart: always
+    environment:
+      # Envs used in Dockerfile
+      # - DOCKER_WORKDIR="/app"
+      - PORT=5000
+      - BUILD_DATE
+      - BUILD_VERSION
+      - BUILD_COMMIT
+      - NODE_ENV="production"
+      - DB_HOST=mariadb
+      # Application only envs
+    #env_file:
+    #  - ./frontend/.env
+    volumes:
+      # <host_machine_directory>:<container_directory> – mirror bidirectional path in local context with path in Docker container
+      - ./logs/federation:/logs/federation
+
  ########################################################
  # DATABASE #############################################
  ########################################################
--- a/federation/Dockerfile
+++ b/federation/Dockerfile
@ -0,0 +1,115 @@
+##################################################################################
+# BASE ###########################################################################
+##################################################################################
+FROM node:18.7.0-alpine3.16 as base
+
+# ENVs (available in production aswell, can be overwritten by commandline or env file)
+## DOCKER_WORKDIR would be a classical ARG, but that is not multi layer persistent - shame
+ENV DOCKER_WORKDIR="/app"
+## We Cannot do `$(date -u +'%Y-%m-%dT%H:%M:%SZ')` here so we use unix timestamp=0
+ENV BUILD_DATE="1970-01-01T00:00:00.00Z"
+## We cannot do $(npm run version).${BUILD_NUMBER} here so we default to 0.0.0.0
+ENV BUILD_VERSION="0.0.0.0"
+## We cannot do `$(git rev-parse --short HEAD)` here so we default to 0000000
+ENV BUILD_COMMIT="0000000"
+## SET NODE_ENV
+ENV NODE_ENV="production"
+## App relevant Envs
+ENV PORT="5000"
+
+# Labels
+LABEL org.label-schema.build-date="${BUILD_DATE}"
+LABEL org.label-schema.name="gradido:federation"
+LABEL org.label-schema.description="Gradido GraphQL Federation"
+LABEL org.label-schema.usage="https://github.com/gradido/gradido/blob/master/README.md"
+LABEL org.label-schema.url="https://gradido.net"
+LABEL org.label-schema.vcs-url="https://github.com/gradido/gradido/tree/master/federation"
+LABEL org.label-schema.vcs-ref="${BUILD_COMMIT}"
+LABEL org.label-schema.vendor="Gradido Community"
+LABEL org.label-schema.version="${BUILD_VERSION}"
+LABEL org.label-schema.schema-version="1.0"
+LABEL maintainer="support@gradido.net"
+
+# Install Additional Software
+## install: git
+#RUN apk --no-cache add git
+
+# Settings
+## Expose Container Port
+EXPOSE ${PORT}
+
+## Workdir
+RUN mkdir -p ${DOCKER_WORKDIR}
+WORKDIR ${DOCKER_WORKDIR}
+
+RUN mkdir -p /database
+
+##################################################################################
+# DEVELOPMENT (Connected to the local environment, to reload on demand) ##########
+##################################################################################
+FROM base as development
+
+# We don't need to copy or build anything since we gonna bind to the
+# local filesystem which will need a rebuild anyway
+
+# Run command
+# (for development we need to execute yarn install since the
+#  node_modules are on another volume and need updating)
+CMD /bin/sh -c "cd /database && yarn install && yarn build && cd /app && yarn install && yarn run dev"
+
+##################################################################################
+# BUILD (Does contain all files and is therefore bloated) ########################
+##################################################################################
+FROM base as build
+
+# Copy everything from federation
+COPY ./federation/ ./
+# Copy everything from database
+COPY ./database/ ../database/
+
+# yarn install federation
+RUN yarn install --production=false --frozen-lockfile --non-interactive
+
+# yarn install database
+RUN cd ../database && yarn install --production=false --frozen-lockfile --non-interactive
+
+# yarn build
+RUN yarn run build
+
+# yarn build database
+RUN cd ../database && yarn run build
+
+##################################################################################
+# TEST ###########################################################################
+##################################################################################
+FROM build as test
+
+# Run command
+CMD /bin/sh -c "yarn run start"
+
+##################################################################################
+# PRODUCTION (Does contain only "binary"- and static-files to reduce image size) #
+##################################################################################
+FROM base as production
+
+# Copy "binary"-files from build image
+COPY --from=build ${DOCKER_WORKDIR}/build ./build
+COPY --from=build ${DOCKER_WORKDIR}/../database/build ../database/build
+# We also copy the node_modules express and serve-static for the run script
+COPY --from=build ${DOCKER_WORKDIR}/node_modules ./node_modules
+COPY --from=build ${DOCKER_WORKDIR}/../database/node_modules ../database/node_modules
+
+# Copy static files
+# COPY --from=build ${DOCKER_WORKDIR}/public ./public
+# Copy package.json for script definitions (lock file should not be needed)
+COPY --from=build ${DOCKER_WORKDIR}/package.json ./package.json
+# Copy tsconfig.json to provide alias path definitions
+COPY --from=build ${DOCKER_WORKDIR}/tsconfig.json ./tsconfig.json
+# Copy log4js-config.json to provide log configuration
+COPY --from=build ${DOCKER_WORKDIR}/log4js-config.json ./log4js-config.json
+
+# Copy run scripts run/
+# COPY --from=build ${DOCKER_WORKDIR}/run ./run
+
+# Run command
+CMD /bin/sh -c "yarn run start"