Merge pull request #72 from metacpan/docker-dev

Multiple improvements during recent PTS25

Author: atoomic

.docker/config.json

@@ -0,0 +1,6 @@
+# ~/.docker/config.json
+{
+  "features": {
+    "buildkit": true
+  }
+}

.dockerignore

@@ -0,0 +1,24 @@
+# .dockerignore
+
+.git
+.gitignore
+
+README.md
+
+deploy/
+launcher/
+local/
+
+src/blib/
+src/environments/*docker*
+src/lib/
+src/public/
+src/t/
+src/var/
+src/views/
+
+tools/
+
+.env
+*.log
+*.swp

ISSUE_TEMPLATE.md renamed to .github/ISSUE_TEMPLATE/bug_report.md

@@ -1,3 +1,12 @@
+---
+name: 🐛 Bug report
+about: Report a problem with the app
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
 ## Context
 
 [provide more detailed introduction to the issue itself and why it is relevant]

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 💬 Community Support
+    url: //github.com/metacpan/metacpan-grep-front-end/discussions/
+    about: Please use GitHub Discussions for questions and support.

.github/workflows/build-production-container.yml

@@ -1,5 +1,5 @@
 ---
-name: Build deployment container
+name: Build production container
 on:
   push:
     branches:

.github/workflows/testsuite.yml

@@ -0,0 +1,36 @@
+name: Run testsuite for grep.metacpan
+
+on:
+  push:
+  #  branches: [ main ]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the main repo
+      - name: Checkout current repo
+        uses: actions/checkout@v4
+        with:
+          path: main-repo
+
+      # Checkout the metacpan-cpan-extracted-lite repo
+      - name: Checkout CPAN repo
+        uses: actions/checkout@v4
+        with:
+          repository: metacpan/metacpan-cpan-extracted-lite
+          path: metacpan-cpan-extracted-lite
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Setup container
+        run: |
+            cd main-repo
+            make test-setup
+
+      # Set up Docker Compose
+      - name: Run tests
+        run: |
+            cd main-repo
+            make test

.gitignore

@@ -1,8 +1,8 @@
 .DS_Store
+.env
 .tidyall.d
 MYMETA.json
 MYMETA.yml
-Makefile
 blib
 local
 pm_to_blib

.travis.yml

@@ -1,9 +1,53 @@
-FROM metacpan/metacpan-base:latest
+##
+##  Temporary image for installing metacpan packages
+##
+
+FROM metacpan/metacpan-base:latest AS builder
+SHELL [ "/bin/bash", "-eo", "pipefail", "-c" ]
+
+# copy the cpanfile and cpanfile.snapshot
+#   from the current directory to the /cpan directory in the image
+    # and install the dependencies using cpm
+# we could then reuse the cpanfile and cpanfile.snapshot for testing
+WORKDIR /cpan
+
+COPY cpanfile ./
+COPY cpanfile.snapshot ./
+
+RUN <<EOT
+    cpm install -g \
+               --without-test \
+               --with-recommends \
+               --with-develop \
+               --cpanfile cpanfile
+EOT
+
+##
+##  Runtime image for metacpan-grep-front-end
+##
+
+FROM builder AS runtime
+SHELL [ "/bin/bash", "-eo", "pipefail", "-c" ]
 
-ADD . /metacpan-grep-front-end
 WORKDIR /metacpan-grep-front-end
 
-RUN cpm install --without-test -g
+# Build arguments
+ARG APP_ENV=development
+
+# Runtime
+ENV APP_ENV=$APP_ENV
+
+# .dockerignore is used to exclude files from the build context
+COPY src/ ./
+
+# always expose a consistent port
 EXPOSE 3000
+# volume controlled by the docker-compose.yml
 VOLUME [ "/metacpan-cpan-extracted" ]
-CMD plackup -p 3000 ${GREP_PLACKUP_SERVER_ARGS} bin/app.psgi
+
+# Make the entrypoint script executable
+RUN chmod +x docker-entrypoint.sh
+
+# Use the dynamic entrypoint
+ENTRYPOINT ["./docker-entrypoint.sh"]
+CMD ["serve"]

Dockerfile

@@ -0,0 +1,40 @@
+
+.PHONY: all up-dev up-prod up test test-setup t
+
+APP_ENV ?= development
+DOCKER_ENV := $(if $(filter $(APP_ENV),test-setup),test,$(APP_ENV))
+
+# Add overload config for docker-compose
+ifeq ($(APP_ENV),development)
+  COMPOSE_FILE=docker-compose.yml:docker-compose.dev.yml
+else ifeq ($(APP_ENV),test-setup)
+  COMPOSE_FILE=docker-compose.yml:docker-compose.dev.yml:docker-compose.test-setup.yml
+else ifeq ($(APP_ENV),test)
+  COMPOSE_FILE=docker-compose.yml:docker-compose.dev.yml:docker-compose.test.yml
+else
+  COMPOSE_FILE=docker-compose.yml
+endif
+
+all:
+	$(MAKE) up
+
+up:
+	ln -sf config/docker-compose.$(DOCKER_ENV).env .env
+	APP_ENV=$(DOCKER_ENV) docker compose -f $(subst :, -f ,$(COMPOSE_FILE)) up --build --exit-code-from grep
+
+up-dev:
+	$(MAKE) up APP_ENV=development
+
+up-prod:
+	$(MAKE) up APP_ENV=production
+
+t: test
+
+test-setup:
+	$(MAKE) up APP_ENV=test-setup
+
+test:
+	$(MAKE) up APP_ENV=test
+
+bash:
+	docker exec -it grep-container /bin/bash