Add unit tests back to pipeline & improve VSCode integration

.config/.codecov.yml

@@ -0,0 +1,5 @@
+# Ignore test files themselves in the Codecov report
+# see: https://about.codecov.io/blog/should-i-include-test-files-in-code-coverage-calculations/
+ignore:
+  - "spec/"
+  - "*_spec.rb"

.github/workflows/docker-compose-cache.json

@@ -0,0 +1,15 @@
+{
+  "target": {
+    "mampf": {
+      "cache-from": [
+        "type=registry,ref=ghcr.io/mampf-hd/mampf:cache"
+      ],
+      "cache-to": [
+        "type=registry,ref=ghcr.io/mampf-hd/mampf:cache"
+      ],
+      "output": [
+        "type=docker"
+      ]
+    }
+  }
+}

.github/workflows/tests.yml

@@ -0,0 +1,62 @@
+name: Testing
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+      - experimental
+  pull_request:
+    types: [opened, reopened, synchronize, ready_for_review]
+
+jobs:
+  # For the setup idea using Docker Buildx, see StackOverflow answer [1].
+  # [2] and [3] might also be very useful. [4] is generally about Docker
+  # cache management within GitHub Actions.
+  #
+  # [1] https://stackoverflow.com/a/75544124/
+  # [2] https://depot.dev/blog/docker-layer-caching-in-github-actions#docker-layer-caching-in-github-actions
+  # [3] https://www.deploysentinel.com/blog/docker-buildx-cache-with-github-actions
+  # [4] https://docs.docker.com/build/ci/github-actions/cache/
+  unit-tests:
+    name: Unit tests
+    environment: testing
+    runs-on: ubuntu-latest
+    permissions: write-all
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+            submodules: recursive
+
+      - name: Setup Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      # see https://github.com/orgs/MaMpf-HD/packages?repo_name=mampf
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build docker images
+        # As the docker-compose.yml file uses contexts like "./../..", we have
+        # to change the working directory here.
+        working-directory: docker/test
+        run: |
+          docker buildx bake --file ./docker-compose.yml --file ./../../.github/workflows/docker-compose-cache.json
+
+      - name: Run unit tests
+        working-directory: docker/test
+        run: |
+          docker compose run --entrypoint="" mampf sh -c "RAILS_ENV=test bundle exec rspec --format RSpec::Github::Formatter"
+
+      - name: Report test coverage to codecov
+        uses: codecov/codecov-action@v4
+        with:
+          fail_ci_if_error: true
+          files: ./coverage/coverage.xml
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true
+          codecov_yml_path: ./config/codecov.yml

.vscode/settings.json

@@ -55,6 +55,16 @@
     },
     "rubyLsp.enableExperimentalFeatures": true,
     //////////////////////////////////////
+    // Ruby Test Explorer
+    //////////////////////////////////////
+    "rubyTestExplorer.testFramework": "rspec",
+    "rubyTestExplorer.rspecCommand": "python3 ./spec/rspec_inside_docker.py",
+    "rubyTestExplorer.rspecDirectory": "./spec/",
+    "rubyTestExplorer.logpanel": true,
+    "rubyTestExplorer.filePattern": [
+        "*_spec.rb"
+    ],
+    //////////////////////////////////////
     // Files
     //////////////////////////////////////
     "files.exclude": {

Gemfile

@@ -123,7 +123,7 @@ group :test do
   # Adds support for Capybara system testing and selenium driver
   gem "selenium-webdriver"
   # Easy installation and use of web drivers to run system tests with browsers
-  gem "database_cleaner"
+  gem "database_cleaner-active_record"
   gem "faker"
   gem "launchy"
   gem "simplecov", require: false
@@ -138,6 +138,8 @@ group :test, :development, :docker_development do
 
   gem "cypress-on-rails", "~> 1.0"
   gem "simplecov-cobertura"
+
+  gem "rspec-github"
 end
 
 gem "prometheus_exporter"

Gemfile.lock

@@ -187,8 +187,6 @@ GEM
     cypress-on-rails (1.17.0)
       rack
     dalli (3.2.8)
-    database_cleaner (2.0.2)
-      database_cleaner-active_record (>= 2, < 3)
     database_cleaner-active_record (2.1.0)
       activerecord (>= 5.a)
       database_cleaner-core (~> 2.0.0)
@@ -497,6 +495,8 @@ GEM
     rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
+    rspec-github (2.4.0)
+      rspec-core (~> 3.0)
     rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
@@ -686,7 +686,7 @@ DEPENDENCIES
   coveralls
   cypress-on-rails (~> 1.0)
   dalli (>= 2.7)
-  database_cleaner
+  database_cleaner-active_record
   devise
   devise-bootstrap-views
   erubis
@@ -726,6 +726,7 @@ DEPENDENCIES
   responders
   rgl
   rqrcode
+  rspec-github
   rspec-rails
   rubocop (~> 1.63)
   rubocop-performance (~> 1.21)

config/webpack/test.js

@@ -1,4 +1,4 @@
-process.env.NODE_ENV = process.env.NODE_ENV || "development";
+process.env.NODE_ENV = process.env.NODE_ENV || "test";
 
 const environment = require("./environment");
 

docker/run_cypress_tests/Dockerfile → docker/test/Dockerfile

@@ -66,5 +66,8 @@ RUN yarn install --production=false
 COPY --from=build-pdfcomprezzor /go/src/pdfcomprezzor.wasm /go/src/wasm_exec.js /usr/src/app/public/pdfcomprezzor/
 COPY --from=build-pdfcomprezzor /go/src/pdfcomprezzor.wasm /go/src/wasm_exec.js /
 
-COPY  ./ /usr/src/app/
-RUN RAILS_ENV=test TEST_DATABASE_ADAPTER=postgresql rake assets:precompile
+COPY . /usr/src/app/
+COPY ./docker/production/docker.env ./docker-dummy.env
+
+RUN set -o allexport && . ./docker-dummy.env && set +o allexport && \
+    RAILS_ENV=test TEST_DATABASE_ADAPTER=nulldb bundle exec rails assets:precompile

docker/run_cypress_tests/docker-compose.local.yml → docker/test/docker-compose.local.yml

@@ -30,12 +30,12 @@ services:
   mampf:
     build:
       context: ./../..
-      dockerfile: docker/run_cypress_tests/Dockerfile
+      dockerfile: docker/test/Dockerfile
     image: mampf:tests
     ports:
       - "127.0.0.1:3000:3000"
     # TODO: Use this
-    # entrypoint: /usr/src/app/docker/run_cypress_tests/run_tests.sh
+    # entrypoint: /usr/src/app/docker/test/run_tests.sh
     entrypoint: ./entrypoint.sh
     environment:
       RAILS_ENV: test
@@ -76,7 +76,7 @@ services:
     image: mampf-cypress
     build:
       context: ./../..
-      dockerfile: docker/run_cypress_tests/Dockerfile_cypress
+      dockerfile: docker/test/Dockerfile_cypress
     environment:
       CYPRESS_baseUrl: http://mampf:3000
     entrypoint: bash -c "while ! curl -s $$CYPRESS_baseUrl > /dev/null; do echo waiting for MaMpf to come online at $$CYPRESS_baseUrl; sleep 1; done; npx cypress run $$@"

docker/run_cypress_tests/docker-compose.yml → docker/test/docker-compose.yml

@@ -33,13 +33,14 @@ services:
     image: dockage/mailcatcher:latest
     networks:
       - backend
+
   mampf:
     build:
       context: ./../..
-      dockerfile: docker/run_cypress_tests/Dockerfile
+      dockerfile: docker/test/Dockerfile
     image: mampf:tests
     # TODO: Use this
-    # entrypoint: /usr/src/app/docker/run_cypress_tests/run_tests.sh
+    # entrypoint: /usr/src/app/docker/test/run_tests.sh
     entrypoint: /usr/src/app/entrypoint.sh
     environment:
       RAILS_ENV: test
@@ -58,14 +59,16 @@ services:
       ERDBEERE_API: https://erdbeere.mathi.uni-heidelberg.de/api/v1
       MUESLI_SERVER: https://muesli.mathi.uni-heidelberg.de
       PROJECT_EMAIL: project@localhost
-      FEEBACK_EMAIL: feedback@localhost
+      FEEDBACK_EMAIL: feedback@localhost
       PROJECT_NOTIFICATION_EMAIL: project+notification@localhost
+      ERROR_EMAIL: mampf-error@localhost
       MEDIA_FOLDER: mampf
       REDIS_URL: redis://redis:6379/1
       SOLR_HOST: solr
       SOLR_PORT: 8983
       SOLR_PATH: /solr/test
       SPROCKETS_CACHE: /cache
+      BLOG: https://mampf.blog
     volumes:
         - type: bind
           source: ../../spec/
@@ -79,23 +82,3 @@ services:
     networks:
       - backend
       - frontend
-
-  cypress_runner:
-    image: mampf-cypress
-    build:
-      context: ./../..
-      dockerfile: docker/run_cypress_tests/Dockerfile_cypress
-    environment:
-      CYPRESS_baseUrl: http://mampf:3000
-    volumes:
-      - ../../spec/cypress/e2e:/cypress/e2e:ro
-      - ../../spec/cypress/fixtures:/cypress/fixtures:ro
-      - ../../spec/cypress.config.js:/cypress.config.js:ro
-      - ../../.git:/.git:ro
-      # cypress outputs are saved here (needed only locally)
-      #- ../../cypress/videos:/cypress/videos
-      #- ../../cypress/screenshots:/cypress/screenshots
-    depends_on:
-      - mampf
-    networks:
-      - frontend

spec/factories/users.rb

@@ -35,5 +35,11 @@
     factory :confirmed_user, traits: [:skip_confirmation_notification,
                                       :auto_confirmed,
                                       :consented]
+
+    factory :confirmed_user_en, traits: [:skip_confirmation_notification,
+                                         :auto_confirmed,
+                                         :consented] do
+      locale { "en" }
+    end
   end
 end

spec/models/announcement_spec.rb

@@ -16,7 +16,7 @@
   # test traits
 
   describe "with lecture" do
-    before :all do
+    before :each do
       @announcement = FactoryBot.build(:announcement, :with_lecture)
     end
     it "has a valid factory" do

spec/models/answer_spec.rb

@@ -15,7 +15,7 @@
   # test traits
 
   describe "with stuff" do
-    before :all do
+    before :each do
       @answer = FactoryBot.build(:answer, :with_stuff)
     end
     it "has a text" do

spec/models/chapter_spec.rb

@@ -15,7 +15,7 @@
   # test traits
 
   describe "chapter with sections" do
-    before :all do
+    before :each do
       @chapter = FactoryBot.build(:chapter, :with_sections)
     end
     it "has a valid factory" do

spec/models/consumption_spec.rb

@@ -8,7 +8,7 @@
   # describe traits
 
   describe "with stuff" do
-    before :all do
+    before :each do
       @consumption = FactoryBot.build(:consumption, :with_stuff)
     end
     it "has a medium id" do