Merge pull request #81 from eea/develop

Release

CHANGELOG.md

@@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+### [6.3.3](https://github.com/eea/volto-columns-block/compare/6.3.2...6.3.3) - 29 August 2023
+
+#### :rocket: New Features
+
+- feat: add Spanish language [Leonardo Caballero - [`2e9baca`](https://github.com/eea/volto-columns-block/commit/2e9baca538250fe287dfc8c253b54f06bf5f5c10)]
+
+#### :house: Documentation changes
+
+- docs: Cleanup Makefile, update DEVELOP documentation, i18n - refs #254894 [valentinab25 - [`54401a7`](https://github.com/eea/volto-columns-block/commit/54401a7a8ab2294312734c3a8be627d1597a224b)]
+
+#### :hammer_and_wrench: Others
+
+- test: Update Makefile and docker-compose to align it with Jenkinsfile [valentinab25 - [`7ad8d40`](https://github.com/eea/volto-columns-block/commit/7ad8d4092f07474c54ea2f83fb43e2af29e82831)]
+- maintenance: Updated i18n support [Leonardo Caballero - [`5d157ec`](https://github.com/eea/volto-columns-block/commit/5d157eccd948336545e71d02d8f7cb37a896c386)]
 ### [6.3.2](https://github.com/eea/volto-columns-block/compare/6.3.1...6.3.2) - 24 July 2023
 
 #### :nail_care: Enhancements

DEVELOP.md

@@ -2,6 +2,28 @@
 
 ## Develop
 
+1. Make sure you have `docker` and `docker compose` installed and running on your machine:
+
+    ```Bash
+    git clone https://github.com/eea/volto-columns-block.git
+    cd volto-columns-block
+    git checkout -b bugfix-123456 develop
+    make
+    make start
+    ```
+
+1. Wait for `Volto started at 0.0.0.0:3000` meesage
+
+1. Go to http://localhost:3000
+
+1.  Happy hacking!
+
+    ```Bash
+    cd src/addons/volto-columns-block/
+    ```
+
+### Or add @eeacms/volto-columns-block to your Volto project
+
 Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)
 
 1.  Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`
@@ -58,3 +80,37 @@ frontend
 1.  Happy hacking!
 
         $ cd src/addons/volto-columns-block/
+
+## Cypress
+
+To run cypress locally, first make sure you don't have any Volto/Plone running on ports `8080` and `3000`.
+
+You don't have to be in a `clean-volto-project`, you can be in any Volto Frontend
+project where you added `volto-columns-block` to `mrs.developer.json`
+
+Go to:
+
+  ```BASH
+  cd src/addons/volto-columns-block/
+  ```
+
+Start:
+
+  ```Bash
+  make
+  make start
+  ```
+
+This will build and start with Docker a clean `Plone backend` and `Volto Frontend` with `volto-columns-block` block installed.
+
+Open Cypress Interface:
+
+  ```Bash
+  make cypress-open
+  ```
+
+Or run it:
+
+  ```Bash
+  make cypress-run
+  ```

Dockerfile

@@ -0,0 +1,14 @@
+# syntax=docker/dockerfile:1
+ARG VOLTO_VERSION
+FROM plone/frontend-builder:${VOLTO_VERSION}
+
+ARG ADDON_NAME
+ARG ADDON_PATH
+
+COPY --chown=node:node ./ /app/src/addons/${ADDON_PATH}/
+
+RUN /setupAddon
+RUN yarn install
+
+ENTRYPOINT ["yarn"]
+CMD ["start"]

Jenkinsfile

@@ -198,6 +198,31 @@ pipeline {
       }
     }
 
+    stage('SonarQube compare to master') {
+      when {
+        allOf {
+          environment name: 'CHANGE_ID', value: ''
+          branch 'develop'
+          not { changelog '.*^Automated release [0-9\\.]+$' }
+        }
+      }
+      steps {
+        node(label: 'docker') {
+          script {
+            sh '''docker pull eeacms/gitflow'''
+            sh '''echo "Error" > checkresult.txt'''
+            catchError(buildResult: 'FAILURE', stageResult: 'FAILURE') {
+               sh '''set -o pipefail; docker run -i --rm --name="$BUILD_TAG-gitflow-sn" -e GIT_BRANCH="$BRANCH_NAME" -e GIT_NAME="$GIT_NAME" eeacms/gitflow /checkSonarqubemaster.sh | grep -v "Found script" | tee checkresult.txt'''
+             }
+
+            publishChecks name: 'SonarQube', title: 'Sonarqube Code Quality Check', summary: "Quality check on the SonarQube metrics from branch develop, comparing it with the ones from master branch. No bugs are allowed",
+                          text: readFile(file: 'checkresult.txt'), conclusion: "${currentBuild.currentResult}",
+                          detailsURL: "${env.BUILD_URL}display/redirect"
+          }
+        }
+      }
+    }
+
     stage('Pull Request') {
       when {
         not {

Makefile

@@ -1,54 +1,95 @@
-SHELL=/bin/bash
+##############################################################################
+# Run:
+#    make
+#    make start
+#
+# Go to:
+#
+#     http://localhost:3000
+#
+# Cypress:
+#
+#    make cypress-open
+#
+##############################################################################
+# SETUP MAKE
+#
+## Defensive settings for make: https://tech.davis-hansson.com/p/make/
+SHELL:=bash
+.ONESHELL:
+# for Makefile debugging purposes add -x to the .SHELLFLAGS
+.SHELLFLAGS:=-eu -o pipefail -O inherit_errexit -c
+.SILENT:
+.DELETE_ON_ERROR:
+MAKEFLAGS+=--warn-undefined-variables
+MAKEFLAGS+=--no-builtin-rules
+
+# Colors
+# OK=Green, warn=yellow, error=red
+ifeq ($(TERM),)
+# no colors if not in terminal
+        MARK_COLOR=
+        OK_COLOR=
+        WARN_COLOR=
+        ERROR_COLOR=
+        NO_COLOR=
+else
+        MARK_COLOR=`tput setaf 6`
+        OK_COLOR=`tput setaf 2`
+        WARN_COLOR=`tput setaf 3`
+        ERROR_COLOR=`tput setaf 1`
+        NO_COLOR=`tput sgr0`
+endif
 
+##############################################################################
+# SETTINGS AND VARIABLE
 DIR=$(shell basename $$(pwd))
-ADDON ?= "@eeacms/volto-columns-block"
-
-# We like colors
-# From: https://coderwall.com/p/izxssa/colored-makefile-for-golang-projects
-RED=`tput setaf 1`
-GREEN=`tput setaf 2`
-RESET=`tput sgr0`
-YELLOW=`tput setaf 3`
+NODE_MODULES?="../../../node_modules"
+PLONE_VERSION?=6
+VOLTO_VERSION?=16
+ADDON_PATH="${DIR}"
+ADDON_NAME="@eeacms/${ADDON_PATH}"
+DOCKER_COMPOSE=PLONE_VERSION=${PLONE_VERSION} VOLTO_VERSION=${VOLTO_VERSION} ADDON_NAME=${ADDON_NAME} ADDON_PATH=${ADDON_PATH} docker compose
+
+# Top-level targets
+.PHONY: all
+all: clean install
+
+.PHONY: clean
+clean:			## Cleanup development environment
+	${DOCKER_COMPOSE} down --volumes --remove-orphans
+
+.PHONY: install
+install:		## Build and install development environment
+	echo "Running:	${DOCKER_COMPOSE} build"
+	${DOCKER_COMPOSE} pull
+	${DOCKER_COMPOSE} build
+
+.PHONY: start
+start:			## Start development environment
+	echo "Running:	${DOCKER_COMPOSE} up"
+	${DOCKER_COMPOSE} up
+
+.PHONY: shell
+shell:			## Start a shell in the frontend container
+	echo "Running:	${DOCKER_COMPOSE} run frontend bash"
+	${DOCKER_COMPOSE} run --entrypoint=bash frontend
 
-ifeq ($(wildcard ./project),)
-  NODE_MODULES = "../../../node_modules"
-else
-  NODE_MODULES = "./project/node_modules"
-endif
+.PHONY: cypress-open
+cypress-open:		## Open cypress integration tests
+	NODE_ENV=development  $(NODE_MODULES)/cypress/bin/cypress open
 
-project:
-	npm install -g yo
-	npm install -g @plone/generator-volto
-	npm install -g mrs-developer
-	yo @plone/volto project --addon ${ADDON} --workspace "src/addons/${DIR}" --no-interactive
-	ln -sf $$(pwd) project/src/addons/
-	cp .project.eslintrc.js .eslintrc.js
-	cd project && yarn
-	@echo "-------------------"
-	@echo "$(GREEN)Volto project is ready!$(RESET)"
-	@echo "$(RED)Now run: cd project && yarn start$(RESET)"
-
-all: project
-
-.PHONY: start-test-backend
-start-test-backend: ## Start Test Plone Backend
-	@echo "$(GREEN)==> Start Test Plone Backend$(RESET)"
-	docker run -i --rm -e ZSERVER_HOST=0.0.0.0 -e ZSERVER_PORT=55001 -p 55001:55001 -e SITE=plone -e APPLY_PROFILES=plone.app.contenttypes:plone-content,plone.restapi:default,kitconcept.volto:default-homepage -e CONFIGURE_PACKAGES=plone.app.contenttypes,plone.restapi,kitconcept.volto,kitconcept.volto.cors -e ADDONS='plone.app.robotframework plone.app.contenttypes plone.restapi kitconcept.volto' plone ./bin/robot-server plone.app.robotframework.testing.PLONE_ROBOT_TESTING
-
-.PHONY: start-backend-docker
-start-backend-docker:		## Starts a Docker-based backend
-	@echo "$(GREEN)==> Start Docker-based Plone Backend$(RESET)"
-	docker run -it --rm --name=plone -p 8080:8080 -e SITE=Plone -e ADDONS="kitconcept.volto" -e ZCML="kitconcept.volto.cors" plone
+.PHONY: cypress-run
+cypress-run:	## Run cypress integration tests
+	NODE_ENV=development  $(NODE_MODULES)/cypress/bin/cypress run
 
 .PHONY: test
 test:			## Run jest tests
-	docker pull plone/volto-addon-ci:alpha
-	docker run -it --rm -e NAMESPACE="@eeacms" -e GIT_NAME="${DIR}" -e RAZZLE_JEST_CONFIG=jest-addon.config.js -v "$$(pwd):/opt/frontend/my-volto-project/src/addons/${DIR}" -e CI="true" plone/volto-addon-ci:alpha
+	${DOCKER_COMPOSE} run -e CI=1 frontend test
 
 .PHONY: test-update
 test-update:	## Update jest tests snapshots
-	docker pull plone/volto-addon-ci:alpha
-	docker run -it --rm -e NAMESPACE="@eeacms" -e GIT_NAME="${DIR}" -e RAZZLE_JEST_CONFIG=jest-addon.config.js -v "$$(pwd):/opt/frontend/my-volto-project/src/addons/${DIR}" -e CI="true" plone/volto-addon-ci:alpha yarn test src/addons/${DIR}/src --watchAll=false -u
+	${DOCKER_COMPOSE} run -e CI=1 frontend test -u
 
 .PHONY: stylelint
 stylelint:		## Stylelint
@@ -84,15 +125,7 @@ i18n:			## i18n
 	rm -rf build/messages
 	NODE_ENV=development $(NODE_MODULES)/.bin/i18n --addon
 
-.PHONY: cypress-run
-cypress-run:	## Run cypress integration tests
-	rm -rf .nyc_output
-	NODE_ENV=development  $(NODE_MODULES)/cypress/bin/cypress run
-
-.PHONY: cypress-open
-cypress-open:	## Open cypress integration tests
-	NODE_ENV=development  $(NODE_MODULES)/cypress/bin/cypress open
-
 .PHONY: help
-help:           ## Show this help.
+help:                   ## Show this help.
 	@echo -e "$$(grep -hE '^\S+:.*##' $(MAKEFILE_LIST) | sed -e 's/:.*##\s*/:/' -e 's/^\(.\+\):\(.*\)/\\x1b[36m\1\\x1b[m:\2/' | column -c2 -t -s :)"
+	head -n 14 Makefile

README.md

@@ -56,6 +56,10 @@ blocks container.
 
 1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
 
+   ```Bash
+   docker compose up backend
+   ```
+
 1. Start Volto frontend
 
 - If you already have a volto project, just update `package.json`:

docker-compose.yml

@@ -0,0 +1,32 @@
+version: "3"
+services:
+  backend:
+    image: eeacms/plone-backend
+    ports:
+      - "8080:8080"
+    environment:
+      SITE: "Plone"
+      PROFILES: "eea.kitkat:testing"
+
+  frontend: 
+    build:
+      context: ./
+      dockerfile: ./Dockerfile
+      args:
+        ADDON_NAME: "${ADDON_NAME}"
+        ADDON_PATH: "${ADDON_PATH}"
+        VOLTO_VERSION: ${VOLTO_VERSION:-16}
+    ports:
+    - "3000:3000"
+    - "3001:3001"
+    depends_on:
+      - backend
+    volumes:
+      - ./:/app/src/addons/${ADDON_PATH}
+    environment:
+      CI: "true"
+      NODE_ENV: "development"
+      RAZZLE_JEST_CONFIG: "src/addons/${ADDON_PATH}/jest-addon.config.js"
+      RAZZLE_INTERNAL_API_PATH: "http://backend:8080/Plone"
+      RAZZLE_DEV_PROXY_API_PATH: "http://backend:8080/Plone"
+      HOST: "0.0.0.0"