update docker compose command change, update action version (#338)

Updates needed to get GitHub Actions up and running.
Note: The `test.yaml` needs to be updated once we get the test template for 2.11 merged into data.gov (PR: GSA/data.gov#5122)

Author: cmhedrickREI

.env

@@ -10,6 +10,7 @@ CKAN_SYSADMIN_NAME=admin
 CKAN_SYSADMIN_PASSWORD=password
 CKAN_SYSADMIN_EMAIL=your_email@example.com
 TZ=UTC
+CKAN_VERSION=2.10
 
 # Database connections (TODO: avoid duplication)
 CKAN_SQLALCHEMY_URL=postgresql://ckan_default:pass@db/ckan_test

.github/workflows/test.yml

@@ -4,7 +4,7 @@ on: [push, workflow_dispatch]
 jobs:
   lint-test:
     name: Lint + Test
-    uses: gsa/data.gov/.github/workflows/ckan-test.yml@main
+    uses: gsa/data.gov/.github/workflows/ckan-test.yml@ckan-211-swig
     with:
       ext_name: dcat_usmetadata
       plugins: dcat_usmetadata usmetadata
@@ -82,9 +82,9 @@ jobs:
           CKAN_VERSION=2.10 yarn install
           CKAN_VERSION=2.10 yarn build
           CKAN_VERSION=2.10 yarn dockerize
-          CKAN_VERSION=2.10 docker-compose -f docker-compose.yml -f docker-compose.cypress.yml run cypress /bin/bash -c "npx wait-on http://ckan:5000/api/action/status_show && npx cypress install && yarn && NODE_ENV=test npx cypress run --spec cypress/integration/${{ matrix.test-files }}"
+          CKAN_VERSION=2.10 docker compose -f docker-compose.yml -f docker-compose.cypress.yml run cypress /bin/bash -c "npx wait-on http://ckan:5000/api/action/status_show --timeout 120000 && npx cypress install && yarn && NODE_ENV=test npx cypress run --spec cypress/integration/${{ matrix.test-files }}"
       - name: cypress-artifacs
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: cypress-artifacts

Dockerfile

@@ -2,7 +2,7 @@ ARG CKAN_VERSION=2.10
 FROM openknowledge/ckan-dev:${CKAN_VERSION}
 ARG CKAN_VERSION
 
-RUN apk add swig
+RUN apk add swig 
 RUN pip install --upgrade pip
 
 COPY . ${APP_DIR}/

README.md

@@ -174,7 +174,7 @@ yarn e2e
 Note, it may be necessary to remove cached images when rebuilding the docker container, in order to ensure that the new usmetadata-app template is included in the build. If you want to make sure that you aren't using cached builds, you can try:
 
 ```bash
-docker-compose build --no-cache --pull ckanext-dcat_usmetadata_app
+docker compose build --no-cache --pull ckanext-dcat_usmetadata_app
 ```
 
 To run e2e tests interactively use:

cypress.json

@@ -1,5 +1,6 @@
 {
   "baseUrl": "http://ckan:5000",
   "chromeWebSecurity": false,
-  "videoCompression": false
+  "videoCompression": false,
+  "requestTimeout": 15000
 }

docker-compose.cypress.yml

@@ -1,11 +1,10 @@
-version: "3.7"
 services:
   cypress:
     image: cypress/included:12.17.2
     environment:
       NODE_ENV: test
     entrypoint: []
-    command: /bin/bash -c 'npx wait-on http://ckan:5000/api/action/status_show && npx cypress install && npx cypress run'
+    command: /bin/bash -c 'npx wait-on http://ckan:5000/api/action/status_show --timeout 120000 && npx cypress install && npx cypress run'
     # Run a specific test
     # command: /bin/bash -c 'npx wait-on http://ckan:5000/api/action/status_show && npx cypress install && npx cypress run --spec cypress/integration/additional-metadata.spec.js'
     ipc: host

docker-compose.yml

@@ -1,11 +1,11 @@
-version: "3.7"
 services:
   ckan:
     image: datagov/ckanext-dcat_usmetadata:${CKAN_VERSION}
     build:
       context: .
       args:
         CKAN_VERSION: ${CKAN_VERSION}
+    hostname: ckan
     env_file:
       - .env
     environment:
@@ -14,7 +14,7 @@ services:
       CKAN_DATASTORE_READ_URL: postgresql://datastore_read:pass@db/datastore_test
       CKAN_SOLR_URL: http://solr:8983/solr/ckan
       CKAN_REDIS_URL: redis://redis:6379/1
-      CKAN_DATAPUSHER_URL: http://localhost:8080/  # datapusher is not really enabled
+      CKAN_DATAPUSHER_URL: http://localhost:8080/ # datapusher is not really enabled
       CKAN__PLUGINS: dcat_usmetadata usmetadata
       PYTHONDONTWRITEBYTECODE: 1
     # command: /bin/bash -c "while ! nc -zv db 5432; do echo \"CKAN** Waiting for DB\"; sleep 3; done; /srv/app/start_ckan_development.sh"
@@ -30,7 +30,7 @@ services:
       - ./test.ini:/srv/app/test.ini
       - ./setup.py:/srv/app/setup.py
       - /etc/timezone:/etc/timezone:ro
-      
+
   db:
     image: ckan/ckan-postgres-dev:${CKAN_VERSION}
     environment:

makefile

@@ -0,0 +1,19 @@
+CKAN_VERSION ?= 2.10
+COMPOSE_FILE ?= docker-compose.yml
+
+build: 
+	CKAN_VERSION=$(CKAN_VERSION) docker compose -f $(COMPOSE_FILE) build
+
+up:
+	CKAN_VERSION=$(CKAN_VERSION) docker compose -f $(COMPOSE_FILE) up
+
+down:
+	docker compose down
+
+.DEFAULT_GOAL := help
+.PHONY: build up
+
+# Output documentation for top-level targets
+# Thanks to https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
+help: ## This help
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-10s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)

package.json

@@ -4,18 +4,18 @@
   "description": "This extension provides a react Admin UI for managing custom fields related to [DCAT-US Schema](https://https://resources.data.gov/resources/dcat-us/).",
   "main": "index.js",
   "scripts": {
-    "build:docker": "docker-compose build",
+    "build:docker": "docker compose build",
     "package": "python setup.py sdist && python setup.py bdist_wheel",
-    "clean": "docker-compose down -v --remove-orphans",
-    "test": "yarn dockerize && docker-compose run --rm ckan /srv/app/test.sh",
-    "up": "docker-compose -f docker-compose.yml up",
-    "lint:python": "docker-compose -f docker-compose.yml run --rm ckan flake8 /srv/app --count --show-source --statistics --exclude ckan --max-line-length 127",
-    "dockerize": "docker-compose -f docker-compose.yml up -d",
+    "clean": "docker compose down -v --remove-orphans",
+    "test": "yarn dockerize && docker compose run --rm ckan /srv/app/test.sh",
+    "up": "docker compose -f docker-compose.yml up",
+    "lint:python": "docker compose -f docker-compose.yml run --rm ckan flake8 /srv/app --count --show-source --statistics --exclude ckan --max-line-length 127",
+    "dockerize": "docker compose -f docker-compose.yml up -d",
     "test:metadata-app": "node react-scripts/test.js --watchAll=false",
     "test:metadata-app:watch": "node react-scripts/test.js --watchAll=true",
     "pre-commit": "echo 'formatting your changes...' && eslint metadata-app/src/ && prettier --write",
-    "e2e": "docker-compose -f docker-compose.yml -f docker-compose.cypress.yml run cypress /bin/bash -c \"npx wait-on http://ckan:5000/api/action/status_show && npx cypress install && yarn && NODE_ENV=test npx cypress run\"",
-    "e2e:interactive": "docker-compose -f docker-compose.yml up -d && yarn && NODE_ENV=test npx cypress open",
+    "e2e": "docker compose -f docker-compose.yml -f docker-compose.cypress.yml run cypress /bin/bash -c \"npx wait-on http://ckan:5000/api/action/status_show --timeout 120000 && npx cypress install && yarn && NODE_ENV=test npx cypress run\"",
+    "e2e:interactive": "docker compose -f docker-compose.yml up -d && yarn && NODE_ENV=test npx cypress open",
     "lint:js": "npx eslint metadata-app/src && npx prettier --check metadata-app/src",
     "rename:builds": "cd ckanext/dcat_usmetadata/public/ && mv assets/css . && mv assets/js .",
     "start:dev": "yarn dockerize && yarn && cd metadata-app && yarn start:metadata-app",
@@ -140,7 +140,8 @@
     "eslint-plugin-react": "^7.22.0",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.11",
-    "prettier": "^2.0.5"
+    "prettier": "^2.0.5",
+    "wait-on": "8.0.3"
   },
   "jest": {
     "roots": [
@@ -205,5 +206,6 @@
     "url": "git@gitlab.com:datopian/clients/ckanext-dcat_usmetadata.git"
   },
   "author": "",
-  "license": "ISC"
+  "license": "ISC",
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

requirements.txt

@@ -11,7 +11,8 @@ repoze.who==2.4
 webob
 
 # ckanext-saml2 dependencies
-M2Crypto==0.36.0
+M2Crypto==0.44.0
+
 #-e git+https://github.com/IdentityPython/pysaml2.git#egg=pysaml2
 pysaml2
 
@@ -27,3 +28,4 @@ pyOpenSSL==20.0.1
 python-memcached==1.58
 pip==23.3.1
 flake8
+packaging==21.3