make testing for the parallel deployment optional and introduce the basic auth option for all supported deployments

2026-01-05 19:59:37 -06:00 · 2022-02-08 10:05:43 +01:00
parent 8cc3c01285
commit 1a3de22448
11 changed files with 47 additions and 13 deletions
--- a/deployments/examples/oc10_ocis_parallel/.env
+++ b/deployments/examples/oc10_ocis_parallel/.env
@@ -58,3 +58,8 @@ KEYCLOAK_ADMIN_PASSWORD=
 # you need uncomment following line. Please see documentation at
 # https://owncloud.dev/ocis/deployment/monitoring-tracing/
 #COMPOSE_FILE=docker-compose.yml:monitoring_tracing/docker-compose-additions.yml
+
+# If you want to use the testsuite with this stack,
+# you need uncomment following line. Please see documentation at
+# https://owncloud.dev/ocis/development/testing/
+#COMPOSE_FILE=docker-compose.yml:testing/docker-compose-additions.yml
--- a/deployments/examples/oc10_ocis_parallel/config/oc10/10-custom-config.sh
+++ b/deployments/examples/oc10_ocis_parallel/config/oc10/10-custom-config.sh
@@ -37,9 +37,4 @@ gomplate \
 occ market:upgrade --major web
 occ app:enable web

-# enable testing app
-echo "Cloning and enabling testing app..."
-git clone --depth 1 https://github.com/owncloud/testing.git /var/www/owncloud/apps/testing
-occ app:enable testing
-
 true
--- a/deployments/examples/oc10_ocis_parallel/config/oc10/11-testing-app.sh
+++ b/deployments/examples/oc10_ocis_parallel/config/oc10/11-testing-app.sh
@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+# enable testing app
+echo "Cloning and enabling testing app..."
+git clone --depth 1 https://github.com/owncloud/testing.git /var/www/owncloud/apps/testing
+occ app:enable testing
+
+true
--- a/deployments/examples/oc10_ocis_parallel/docker-compose.yml
+++ b/deployments/examples/oc10_ocis_parallel/docker-compose.yml
@@ -123,6 +123,7 @@ services:
      OCIS_MACHINE_AUTH_API_KEY: ${OCIS_MACHINE_AUTH_API_KEY:-change-me-please}
      # INSECURE: needed if oCIS / Traefik is using self generated certificates
      OCIS_INSECURE: "${INSECURE:-false}"
+      # basic auth (not recommended, but needed for eg. WebDav clients that do not support OpenID Connect)
      PROXY_ENABLE_BASIC_AUTH: "${PROXY_ENABLE_BASIC_AUTH:-false}"
    volumes:
      - ./config/ocis/proxy.json:/etc/ocis/proxy.json
@@ -144,8 +145,6 @@ services:
    image: owncloud/server:${OC10_DOCKER_TAG:-latest}
    networks:
      ocis-net:
-    ports:
-      - 8080:8080
    environment:
      # make ownCloud Web the default frontend
      OWNCLOUD_DEFAULT_APP: ${OWNCLOUD_DEFAULT_APP:-files} # can be switched to "web"
@@ -251,8 +250,6 @@ services:
    image: osixia/openldap:latest
    networks:
      ocis-net:
-    ports:
-      - 636:636
    command: --copy-service --loglevel debug
    environment:
      LDAP_TLS_VERIFY_CLIENT: never
--- a/deployments/examples/oc10_ocis_parallel/testing/docker-compose-additions.yml
+++ b/deployments/examples/oc10_ocis_parallel/testing/docker-compose-additions.yml
@@ -0,0 +1,17 @@
+---
+version: "3.7"
+
+services:
+  ocis:
+    environment:
+      PROXY_ENABLE_BASIC_AUTH: true
+
+  oc10:
+    ports:
+      - 8080:8080
+    volumes:
+      - ./config/oc10/11-testing-app.sh:/etc/pre_server.d/11-testing-app.sh
+
+  openldap:
+    ports:
+      - 636:636
--- a/deployments/examples/ocis_hello/docker-compose.yml
+++ b/deployments/examples/ocis_hello/docker-compose.yml
@@ -66,6 +66,8 @@ services:
      SETTINGS_GRPC_ADDR: 0.0.0.0:9191
      # INSECURE: needed if oCIS / Traefik is using self generated certificates
      OCIS_INSECURE: "${INSECURE:-false}"
+      # basic auth (not recommended, but needed for eg. WebDav clients that do not support OpenID Connect)
+      PROXY_ENABLE_BASIC_AUTH: "${PROXY_ENABLE_BASIC_AUTH:-false}"
    volumes:
      - ./config/ocis/entrypoint-override.sh:/entrypoint-override.sh
      - ./config/ocis/web-config.dist.json:/config/web-config.dist.json
--- a/deployments/examples/ocis_ldap/docker-compose.yml
+++ b/deployments/examples/ocis_ldap/docker-compose.yml
@@ -86,6 +86,8 @@ services:
      OCIS_MACHINE_AUTH_API_KEY: ${OCIS_MACHINE_AUTH_API_KEY:-change-me-please}
      # INSECURE: needed if oCIS / Traefik is using self generated certificates
      OCIS_INSECURE: "${INSECURE:-false}"
+      # basic auth (not recommended, but needed for eg. WebDav clients that do not support OpenID Connect)
+      PROXY_ENABLE_BASIC_AUTH: "${PROXY_ENABLE_BASIC_AUTH:-false}"
    volumes:
      - ./config/ocis/entrypoint-override.sh:/entrypoint-override.sh
      - ./config/ocis/web-config.dist.json:/config/web-config.dist.json
--- a/deployments/examples/ocis_s3/docker-compose.yml
+++ b/deployments/examples/ocis_s3/docker-compose.yml
@@ -70,6 +70,8 @@ services:
      STORAGE_USERS_DRIVER_S3NG_BUCKET: ${MINIO_BUCKET:-ocis-bucket}
      # INSECURE: needed if oCIS / Traefik is using self generated certificates
      OCIS_INSECURE: "${INSECURE:-false}"
+      # basic auth (not recommended, but needed for eg. WebDav clients that do not support OpenID Connect)
+      PROXY_ENABLE_BASIC_AUTH: "${PROXY_ENABLE_BASIC_AUTH:-false}"
    volumes:
      - ./config/ocis/entrypoint-override.sh:/entrypoint-override.sh
      - ocis-data:/var/lib/ocis
--- a/deployments/examples/ocis_traefik/docker-compose.yml
+++ b/deployments/examples/ocis_traefik/docker-compose.yml
@@ -61,6 +61,8 @@ services:
      OCIS_MACHINE_AUTH_API_KEY: ${OCIS_MACHINE_AUTH_API_KEY:-change-me-please}
      # INSECURE: needed if oCIS / Traefik is using self generated certificates
      OCIS_INSECURE: "${INSECURE:-false}"
+      # basic auth (not recommended, but needed for eg. WebDav clients that do not support OpenID Connect)
+      PROXY_ENABLE_BASIC_AUTH: "${PROXY_ENABLE_BASIC_AUTH:-false}"
    volumes:
      - ./config/ocis/entrypoint-override.sh:/entrypoint-override.sh
      - ocis-data:/var/lib/ocis
--- a/deployments/examples/ocis_wopi/docker-compose.yml
+++ b/deployments/examples/ocis_wopi/docker-compose.yml
@@ -54,7 +54,6 @@ services:
      - /bin/sh
      - /entrypoint-override.sh
    environment:
-      PROXY_ENABLE_BASIC_AUTH: "true"
      OCIS_URL: https://${OCIS_DOMAIN:-ocis.owncloud.test}
      OCIS_DOMAIN: ${OCIS_DOMAIN:-ocis.owncloud.test}
      OCIS_LOG_LEVEL: ${OCIS_LOG_LEVEL:-error} # make oCIS less verbose
@@ -70,6 +69,8 @@ services:
      STORAGE_APP_REGISTRY_MIMETYPES_JSON: /var/tmp/ocis/app-config/mimetypes.json
      # INSECURE: needed if oCIS / Traefik is using self generated certificates
      OCIS_INSECURE: "${INSECURE:-false}"
+      # basic auth (not recommended, but needed for eg. WebDav clients that do not support OpenID Connect)
+      PROXY_ENABLE_BASIC_AUTH: "${PROXY_ENABLE_BASIC_AUTH:-false}"
    volumes:
      - ./config/ocis/entrypoint-override.sh:/entrypoint-override.sh
      - ./config/ocis/mimetypes.json:/var/tmp/ocis/app-config/mimetypes.json
--- a/docs/ocis/development/testing.md
+++ b/docs/ocis/development/testing.md
@@ -173,14 +173,17 @@ If you want to work on a specific issue

 Instruction on setup is available [here](https://owncloud.dev/ocis/deployment/oc10_ocis_parallel/#local-setup)

+Edit the `.env` file and uncomment this line:
+```
+COMPOSE_FILE=docker-compose.yml:testing/docker-compose-additions.yml
+```
+
 Start the docker stack with the following command:

 ```bash
-PROXY_ENABLE_BASIC_AUTH=true docker-compose up -d
+docker-compose up -d
 ```

-**NOTE**: `PROXY_ENABLE_BASIC_AUTH=true` is required as the tests use basic auth.
-
 ### Getting the test helpers

 All the test helpers are located in the core repo.