Merge branch 'main' into notif-ws

Author: Potherca

.github/workflows/ci.yml

@@ -1,29 +1,154 @@
-# This workflow will do a clean install of node dependencies, build the source
-# code and run tests across different versions of node
-# For more information see:
-# https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+---
+name: Solid Test Suites
 
-name: CI
+env:
+  # Docker Hub digest (i.e. hash) of the used Docker Images that do not have a version tag.
+  PUBSUB_TAG: latest@sha256:35166933e3d30bde801fd156bd2f21ebba9cdeca464ebd574c6be4cdb14d35cd
+  COOKIE_TAG: latest@sha256:c71a3947f97d96ce09823743182582e0d919738be0d4ef5c8c55a9c22c615b91
 
 on:
   push:
-    branches: [ main ]
+    branches:
+      - main
   pull_request:
     branches: [ main ]
+  # Allow manually triggering the workflow.
+  workflow_dispatch:
+
+# Cancels all previous workflow runs for the same branch that have not yet completed.
+concurrency:
+  # The concurrency group contains the workflow name and the branch name.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
-  build:
+  # @TODO: Instead of building the docker image here, take a pre-build image and mount the code?
+  #        (only build when the Dockerfile changes) Or only push when tagged/main?
+  build-docker-nextcloud:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # For the latest version information see: https://github.com/nextcloud/server/wiki/Maintenance-and-Release-Schedule
+        # Versions before 22 are not tested as they run on PHP versions lower than 8.0
+        # Versions before 24 are not tested as they do not support `.well-known` entries
+        # Version 24 comes with PHP 8.0, which is no longer supported;
+        # Latest is not tested here, as that could cause failures unrelated to project changes
+        nextcloud_version:
+          - 28
+          - 29
+          - 30
+
+    steps:
+      - name: Create docker tag from git reference
+        # A tag name may only contain lower- and uppercase letters, digits, underscores, periods and dashes.
+        run: |
+          echo "TAG=$(echo -n "${{ github.ref_name }}-${{ matrix.nextcloud_version }}" \
+            | tr --complement --squeeze-repeats '[:alnum:]._-' '_')" \
+            >> "${GITHUB_ENV}"
+
+      - uses: actions/cache@v3
+        id: cache-solid-nextcloud-docker
+        with:
+          path: cache/solid-nextcloud
+          key: solid-nextcloud-docker-${{ matrix.nextcloud_version }}-${{ github.sha }}
+
+      - uses: actions/checkout@v3
+
+      - uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build Solid-Nextcloud Docker image from NC-${{ matrix.nextcloud_version }}
+        run: |
+          docker build \
+            --tag "solid-nextcloud:${{ env.TAG }}" \
+            --tag "ghcr.io/pdsinterop/solid-nextcloud:${{ env.TAG }}" \
+            --build-arg 'NEXTCLOUD_VERSION=${{ matrix.nextcloud_version }}' \
+          .
+          docker push "ghcr.io/pdsinterop/solid-nextcloud:${{ env.TAG }}"
+          mkdir -p cache/solid-nextcloud
+          docker image save solid-nextcloud:${{ env.TAG }} --output ./cache/solid-nextcloud/${{ github.sha }}-${{ matrix.nextcloud_version }}.tar
+
+  solid-testsuite:
+    timeout-minutes: 30
+    needs:
+      - build-docker-nextcloud
 
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
 
     strategy:
+      fail-fast: false
       matrix:
-        os: [ ubuntu-latest ]
+        nextcloud_version:
+          - 28
+          - 29
+          - 30
+        test:
+          - 'solidtestsuite/solid-crud-tests:v7.0.5'
+          - 'solidtestsuite/web-access-control-tests:v7.1.0'
+          - 'solidtestsuite/webid-provider-tests:v2.1.0'
+
+    # Prevent EOL or non-stable versions of Nextcloud to fail the test-suite
+    continue-on-error: ${{ contains(fromJson('[28,29,30]'), matrix.nextcloud_version) == false }}
 
     steps:
-      - uses: actions/checkout@v2
-      # Run the Solid test-suite
-      - name: Run the Solid test suite
-        shell: 'script -q -e -c "bash {0}"'
+      - name: Create docker tag from git reference
+        # A tag name may only contain lower- and uppercase letters, digits, underscores, periods and dashes.
         run: |
-          bash ./run-solid-test-suite.sh
+          echo "TAG=$(echo -n "${{ github.ref_name }}-${{ matrix.nextcloud_version }}" \
+            | tr --complement --squeeze-repeats '[:alnum:]._-' '_')" \
+            >> "${GITHUB_ENV}"
+
+      - uses: actions/checkout@v3
+
+      - uses: actions/cache@v3
+        id: cache-solid-nextcloud-docker
+        with:
+          path: cache/solid-nextcloud
+          key: solid-nextcloud-docker-${{ matrix.nextcloud_version }}-${{ github.sha }}
+
+      - uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # FIXME: The `docker pull` should be moved to a previous step and cached
+      - name: Pull docker Images
+        run: |
+          docker image load --input ./cache/solid-nextcloud/${{ github.sha }}-${{ matrix.nextcloud_version }}.tar
+          docker pull michielbdejong/nextcloud-cookie:${{ env.COOKIE_TAG }}
+          docker pull ${{ matrix.test }}
+          docker pull ghcr.io/pdsinterop/php-solid-pubsub-server:${{ env.PUBSUB_TAG }}
+
+      - name: Start Docker Containers
+        run: |
+          docker network create testnet
+          docker run \
+            --detach \
+            --interactive \
+            --name 'pubsub' \
+            --network=testnet \
+            "ghcr.io/pdsinterop/php-solid-pubsub-server:${{ env.PUBSUB_TAG }}"
+
+          source ./run-solid-test-suite.sh
+          startSolidNextcloud 'server' "solid-nextcloud:${{ env.TAG }}" ${{ matrix.test }}
+          startSolidNextcloud 'thirdparty' "solid-nextcloud:${{ env.TAG }}" ${{ matrix.test }}
+
+          echo "COOKIE_server=${COOKIE_server}" >> "${GITHUB_ENV}"
+          echo "COOKIE_thirdparty=${COOKIE_thirdparty}" >> "${GITHUB_ENV}"
+
+      - name: Run tests - ${{ matrix.test }}
+        run: |
+          export COOKIE_server="${{ env.COOKIE_server }}"
+          export COOKIE_thirdparty="${{ env.COOKIE_thirdparty }}"
+
+          docker run -i --rm --network=testnet \
+            --name tester \
+            --env COOKIE="$COOKIE_server" \
+            --env COOKIE_ALICE="$COOKIE_server" \
+            --env COOKIE_BOB="$COOKIE_thirdparty" \
+            --env-file ./env-vars-testers.list \
+            ${{ matrix.test }}

.github/workflows/dependancy-security-check.yml

@@ -20,7 +20,7 @@ jobs:
 
     strategy:
       matrix:
-        php: ['8.0', '8.1']
+        php: ['8.1']
 
     steps:
       - name: Checkout code

.github/workflows/php-version-sniff.yml

@@ -17,7 +17,7 @@ jobs:
   php-codesniffer:
     strategy:
       matrix:
-        php: [ '8.0', '8.1' ]
+        php: [ '8.1' ]
     runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v3

Dockerfile

@@ -1,26 +1,27 @@
-FROM nextcloud:24.0.1
-COPY site.conf /etc/apache2/sites-enabled/000-default.conf
-RUN a2enmod ssl
-RUN mkdir /tls
-RUN openssl req -new -x509 -days 365 -nodes \
-  -out /tls/server.cert \
-  -keyout /tls/server.key \
-  -subj "/C=RO/ST=Bucharest/L=Bucharest/O=IT/CN=www.example.ro"
+ARG NEXTCLOUD_VERSION
+FROM nextcloud:${NEXTCLOUD_VERSION}
+
 RUN apt-get update && apt-get install -yq \
-  git \
-  vim \
-  sudo
-WORKDIR /install
-RUN php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
-RUN php composer-setup.php
-RUN php -r "unlink('composer-setup.php');"
-ADD ./solid /usr/src/nextcloud/apps/solid
-# Run composer:
-WORKDIR /usr/src/nextcloud/apps/solid
-RUN ls
-RUN php /install/composer.phar update
-RUN php /install/composer.phar install --no-dev --prefer-dist
+      git \
+      sudo \
+      vim \
+      zip \
+    && rm -rf /var/lib/apt/lists/* \
+    && a2enmod ssl \
+    && mkdir /tls \
+    && openssl req -new -x509 -days 365 -nodes \
+      -keyout /tls/server.key \
+      -out /tls/server.cert \
+      -subj "/C=RO/ST=Bucharest/L=Bucharest/O=IT/CN=www.example.ro"
+
+COPY solid/ /usr/src/nextcloud/apps/solid
+COPY init.sh /
+COPY init-live.sh /
+COPY site.conf /etc/apache2/sites-enabled/000-default.conf
+
+COPY --from=composer:latest /usr/bin/composer /usr/local/bin/composer
+RUN composer install --working-dir=/usr/src/nextcloud/apps/solid --no-dev --prefer-dist \
+    && rm  /usr/local/bin/composer
+
 WORKDIR /var/www/html
-ADD init.sh /
-ADD init-live.sh /
 EXPOSE 443

INSTALL.md

@@ -1,11 +1,10 @@
 # Installing this app to your Nextcloud
 
 If you have installed Nextcloud [using snap](https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-nextcloud-on-ubuntu-22-04)
-you should be able to run the latest version of this app.
+you should be able to run the latest version of this app. You can find it in the Nextcloud app store as `Solid`, or by running `sudo nextcloud.occ app:install solid`.
 
 ## Building from source
-In the future you will be able to install the app just from the app store, or by running `sudo nextcloud.occ app:install solid`.
-But currently (September 2022) that still installs version 0.0.3, which means you need to install from source. To switch the version of your Solid app from the "store-bought" version to the latest unreleased version, you will need to build from source:
+To switch the version of your Solid app from the "store-bought" version to the latest unreleased version, you will need to build from source:
 ```
 sudo /bin/bash
 cd /var/snap/nextcloud/current/nextcloud/extra-apps/

README.md

@@ -2,7 +2,6 @@
 A plugin to make Nextcloud compatible with Solid.
 
 You can download it via the Nextcloud app store: https://apps.nextcloud.com/apps/solid
-IMPORTANT: Follow the [install instructions!](https://github.com/pdsinterop/solid-nextcloud/blob/main/INSTALL.md).
 
 ## Development install
 Clone https://github.com/pdsinterop/test-suites, cd into it, and run:
@@ -21,40 +20,14 @@ docker exec -u root -it server service apache2 reload
 Now visit https://localhost and log in as alice / alice123.
 
 ## Manual install
-Pleas follow the [install instructions](https://github.com/pdsinterop/solid-nextcloud/blob/main/INSTALL.md).
+Please follow the [install instructions](https://github.com/pdsinterop/solid-nextcloud/blob/main/INSTALL.md).
 
 ## Unattended testing
 There is a [GitHub Action](https://github.com/pdsinterop/solid-nextcloud/actions/workflows/ci.yml) that runs a [Docker-based test script](https://github.com/pdsinterop/solid-nextcloud/blob/585b968/.github/workflows/ci.yml#L29).
 
 ## Manual testing
 You can try out the various Solid apps that show up in the Solid App GUI inside the Nextcloud GUI on first use.
 
-# Publishing to the Nextcloud app store
+### Build / Deploy
 
-* `git checkout main`
-* `git pull`
-* Tag v0.0.X in solid/appinfo/info.xml
-* `git tag`
-* `git tag v0.0.X`
-* `git push --follow-tags`
-* `git checkout publish`
-* `git pull`
-* `git merge main`
-* `cd solid`
-* `php ../composer.phar update`
-* `php ../composer.phar install --no-dev --prefer-dist`
-* `git commit -am"built"` (at least `vendor/composer/installed.php` will have changed)
-* `git push`
-* `cd ..`
-* create a release on github from the tag you just pushed
-* `tar -cf solid.tar solid/`
-* `gzip solid.tar`
-* `git checkout main`
-* edit the release and upload `solid.tar.gz` as a binary attachment
-* make sure transfer/solid.key and transfer/solid.crt exist
-* `openssl dgst -sha512 -sign ./transfer/solid.key ./solid.tar.gz | openssl base64`
-* visit https://apps.nextcloud.com/developer/apps/releases/new
-* go into the developer tools browser console to change the `<a>` element around the form to a `<p>` element. This makes it possible to fill in values in this form without being redirected.
-* fill in for instance `https://github.com/pdsinterop/solid-nextcloud/releases/download/v0.0.2/solid.tar.gz` and the base64 signature from the openssl command
-* click 'uploaden'
-* good luck!
+For publishing to the Nextcloud app store see [the deploy instructions](docs/deploy.md).