Merge pull request #71 from RegioneER/plone6_volto

Plone6 and volto compatibility

.editorconfig

@@ -1,15 +1,54 @@
-[*]
-indent_style = space
+# Generated from:
+# https://github.com/plone/meta/tree/master/config/default
+# See the inline comments on how to expand/tweak this configuration file
+#
+# EditorConfig Configuration file, for more details see:
+# http://EditorConfig.org
+# EditorConfig is a convention description, that could be interpreted
+# by multiple editors to enforce common coding conventions for specific
+# file types
+
+# top-most EditorConfig file:
+# Will ignore other EditorConfig files in Home directory or upper tree level.
+root = true
+
+
+[*]  # For All Files
+# Unix-style newlines with a newline ending every file
 end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
+# Set default charset
 charset = utf-8
+# Indent style default
+indent_style = space
+# Max Line Length - a hard line wrap, should be disabled
+max_line_length = off
 
-[{*.py,*.cfg}]
+[*.{py,cfg,ini}]
+# 4 space indentation
 indent_size = 4
 
-[{*.html,*.dtml,*.pt,*.zpt,*.xml,*.zcml,*.js}]
+[*.{yml,zpt,pt,dtml,zcml}]
+# 2 space indentation
 indent_size = 2
 
-[Makefile]
+[*.{json,jsonl,js,jsx,ts,tsx,css,less,scss,html}]  # Frontend development
+# 2 space indentation
+indent_size = 2
+max_line_length = 80
+
+[{Makefile,.gitmodules}]
+# Tab indentation (no size specified, but view as 4 spaces)
 indent_style = tab
+indent_size = unset
+tab_width = unset
+
+
+##
+# Add extra configuration options in .meta.toml:
+#  [editorconfig]
+#  extra_lines = """
+#  _your own configuration lines_
+#  """
+##

.github/workflows/black.yml

@@ -0,0 +1,35 @@
+name: Black
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.8]
+
+    steps:
+      # git checkout
+      - uses: actions/checkout@v2
+
+      # python setup
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      # python cache
+      - uses: actions/cache@v1
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      # install black
+      - name: install black
+        run: pip install black
+
+      # run black
+      - name: run black
+        run: black src/ --check --diff

.github/workflows/flake8.yml

@@ -0,0 +1,35 @@
+name: Flake8
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.8]
+
+    steps:
+      # git checkout
+      - uses: actions/checkout@v2
+
+      # python setup
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      # python cache
+      - uses: actions/cache@v1
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      # install flake8
+      - name: install flake8
+        run: pip install flake8
+
+      # run black
+      - name: run flake8
+        run: flake8 src/ setup.py

.github/workflows/pyroma.yml

@@ -0,0 +1,35 @@
+name: Pyroma
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.8]
+
+    steps:
+      # git checkout
+      - uses: actions/checkout@v2
+
+      # python setup
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      # python cache
+      - uses: actions/cache@v1
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      # install pyroma
+      - name: install pyroma
+        run: pip install pyroma
+
+      # run pyroma
+      - name: run pyroma
+        run: pyroma -n 10 -d .

.github/workflows/tests.yml

@@ -1,38 +1,67 @@
 name: Tests
 
-on: [push]
-
+on:
+  push:
+    paths-ignore:
+      - '**.md'
+      - '**.rst'
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 4
       matrix:
-        python: ['3.7']
-        plone: ['52']
+        python: ["3.8", "3.9", "3.10", "3.11"]
+        plone: ["52", "60"]
+        tz: ["UTC", "Europe/Rome"]
         exclude:
-          - python: '3.7'
-            plone: '51'
+          - python: "3.10"
+            plone: "52"
+          - python: "3.11"
+            plone: "52"
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
       - name: Cache eggs
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         with:
           path: eggs
           key: ${{ runner.OS }}-build-python${{ matrix.python }}-${{ matrix.plone }}
       - name: Set up Python ${{ matrix.python }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python }}
       - name: Install dependencies
         run: |
           pip install -r requirements.txt -c constraints_plone${{ matrix.plone }}.txt
-          pip install setuptools==40.8.0
           cp test_plone${{ matrix.plone }}.cfg buildout.cfg
       - name: Install buildout
         run: |
-          buildout -N -t 3 code-analysis:return-status-codes=True
-      - name: Run tests
+          buildout -N code-analysis:return-status-codes=True
+      - name: Code analysis
         run: |
           bin/code-analysis
-          bin/test
+      - name: Run tests
+        run: |
+          bin/test-coverage
+        env:
+          PROXY_BEARER_AUTH: on
+          TZ: ${{ matrix.tz }}
+      - name: Upload coverage data to coveralls.io
+        run: |
+          pip install coveralls
+          coveralls --service=github
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COVERALLS_FLAG_NAME: py${{ matrix.python }}-plone${{ matrix.plone }}-tz${{ matrix.tz }}
+          COVERALLS_PARALLEL: true
+
+  coveralls_finish:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+    - name: Finished
+      run: |
+        pip install --upgrade coveralls
+        coveralls --service=github --finish
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/zpretty.yml

@@ -0,0 +1,40 @@
+name: zpretty
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.8]
+
+    steps:
+      # git checkout
+      - uses: actions/checkout@v2
+
+      # python setup
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      # python cache
+      - uses: actions/cache@v1
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      # install zpretty
+      - name: install zpretty
+        run: pip install zpretty
+
+      # run zpretty
+      - name: run zpretty
+        run: find src -name '*.zcml' | xargs zpretty -i
+
+      # XXX: this doesn't work on gh actions (https://github.com/plone/plone.restapi/pull/1119/checks?check_run_id=2686474411)
+      # run git diff
+      - name: run git diff
+        run: git diff --exit-code

.gitignore

@@ -16,6 +16,8 @@ config/dev/conf/_schema_analysis_stopwords_english.json
 config/test/conf/_schema_analysis_stopwords_english.json
 config/dev/data/
 config/test/data/
+config/solr.xml
+config/zoo.cfg
 develop-eggs/
 eggs/
 extras/

CHANGES.rst

@@ -5,7 +5,8 @@ Changelog
 1.3.4 (unreleased)
 ------------------
 
-- Nothing changed yet.
+- Plone6 compatibility.
+  [cekk]
 
 
 1.3.3 (2023-11-08)

base.cfg

@@ -16,8 +16,9 @@ parts =
     releaser
     i18ndude
     omelette
-    robot
     plone-helper-scripts
+    zpretty
+    zpretty-run
 
 develop = .
 
@@ -48,7 +49,7 @@ recipe = plone.recipe.codeanalysis
 directory = ${buildout:directory}/src
 flake8-exclude=bootstrap.py,bootstrap-buildout.py,docs,bin,*.egg,setup.py,overrides,omelette
 flake8-max-complexity = 25
-# flake8-ignore = E203, E266, E501, W503
+flake8-ignore = E203, E266, E501, W503, C101
 flake8-max-line-length = 200
 # flake8-select = B,C,E,F,W,T4,B9
 flake8-extensions =
@@ -87,7 +88,7 @@ input = inline:
     export TZ=UTC
     ${buildout:directory}/bin/coverage run bin/test $*
     ${buildout:directory}/bin/coverage html
-    ${buildout:directory}/bin/coverage report -m --fail-under=90
+    ${buildout:directory}/bin/coverage report -m --fail-under=70
     # Fail (exit status 1) if coverage returns exit status 2 (this happens
     # when test coverage is below 100%.
 output = ${buildout:directory}/bin/test-coverage
@@ -99,12 +100,18 @@ recipe = zc.recipe.egg
 eggs = createcoverage
 
 
-[robot]
+[zpretty]
 recipe = zc.recipe.egg
 eggs =
-    ${test:eggs}
-    plone.app.robotframework[debug,reload]
+   zpretty
 
+[zpretty-run]
+recipe = collective.recipe.template
+input = inline:
+    #!/bin/bash
+    find src -name '*.zcml' | xargs bin/zpretty -i
+output = ${buildout:directory}/bin/zpretty-run
+mode = 755
 
 [releaser]
 recipe = zc.recipe.egg

buildout.cfg

@@ -5,4 +5,5 @@ extends =
 # -*- mrbob: extra extends -*-
 #    test_plone50.cfg
 #    test_plone51.cfg
-    test_plone52.cfg
+#    test_plone52.cfg
+    test_plone60.cfg