diff --git a/.eslintrc.json b/.eslintrc.json
index af1b97849b..6920cc4712 100644
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -231,10 +231,13 @@
"*.json5"
],
"extends": [
- "plugin:jsonc/recommended-with-jsonc"
+ "plugin:jsonc/recommended-with-json5"
],
"rules": {
- "no-irregular-whitespace": "error",
+ // The ESLint core no-irregular-whitespace rule doesn't work well in JSON
+ // See: https://ota-meshi.github.io/eslint-plugin-jsonc/rules/no-irregular-whitespace.html
+ "no-irregular-whitespace": "off",
+ "jsonc/no-irregular-whitespace": "error",
"no-trailing-spaces": "error",
"jsonc/comma-dangle": [
"error",
diff --git a/.github/disabled-workflows/pull_request_opened.yml b/.github/disabled-workflows/pull_request_opened.yml
deleted file mode 100644
index 0dc718c0b9..0000000000
--- a/.github/disabled-workflows/pull_request_opened.yml
+++ /dev/null
@@ -1,26 +0,0 @@
-# This workflow runs whenever a new pull request is created
-# TEMPORARILY DISABLED. Unfortunately this doesn't work for PRs created from forked repositories (which is how we tend to create PRs).
-# There is no known workaround yet. See https://github.community/t/how-to-use-github-token-for-prs-from-forks/16818
-name: Pull Request opened
-
-# Only run for newly opened PRs against the "main" branch
-on:
- pull_request:
- types: [opened]
- branches:
- - main
-
-jobs:
- automation:
- runs-on: ubuntu-latest
- steps:
- # Assign the PR to whomever created it. This is useful for visualizing assignments on project boards
- # See https://github.com/marketplace/actions/pull-request-assigner
- - name: Assign PR to creator
- uses: thomaseizinger/assign-pr-creator-action@v1.0.0
- # Note, this authentication token is created automatically
- # See: https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token
- with:
- repo-token: ${{ secrets.GITHUB_TOKEN }}
- # Ignore errors. It is possible the PR was created by someone who cannot be assigned
- continue-on-error: true
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 219074780e..a72d0d6c18 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -7,7 +7,8 @@ name: Build
on: [push, pull_request]
permissions:
- contents: read # to fetch code (actions/checkout)
+ contents: read # to fetch code (actions/checkout)
+ packages: read # to fetch private images from GitHub Container Registry (GHCR)
jobs:
tests:
@@ -33,21 +34,26 @@ jobs:
#CHROME_VERSION: "90.0.4430.212-1"
# Bump Node heap size (OOM in CI after upgrading to Angular 15)
NODE_OPTIONS: '--max-old-space-size=4096'
+ # Project name to use when running "docker compose" prior to e2e tests
+ COMPOSE_PROJECT_NAME: 'ci'
+ # Docker Registry to use for Docker compose scripts below.
+ # We use GitHub's Container Registry to avoid aggressive rate limits at DockerHub.
+ DOCKER_REGISTRY: ghcr.io
strategy:
# Create a matrix of Node versions to test against (in parallel)
matrix:
- node-version: [16.x, 18.x]
+ node-version: [18.x, 20.x]
# Do NOT exit immediately if one matrix job fails
fail-fast: false
# These are the actual CI steps to perform per job
steps:
# https://github.com/actions/checkout
- name: Checkout codebase
- uses: actions/checkout@v3
+ uses: actions/checkout@v4
# https://github.com/actions/setup-node
- name: Install Node.js ${{ matrix.node-version }}
- uses: actions/setup-node@v3
+ uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
@@ -72,7 +78,7 @@ jobs:
id: yarn-cache-dir-path
run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
- name: Cache Yarn dependencies
- uses: actions/cache@v3
+ uses: actions/cache@v4
with:
# Cache entire Yarn cache directory (see previous step)
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
@@ -99,26 +105,34 @@ jobs:
# so that it can be shared with the 'codecov' job (see below)
# NOTE: Angular CLI only supports code coverage for specs. See https://github.com/angular/angular-cli/issues/6286
- name: Upload code coverage report to Artifact
- uses: actions/upload-artifact@v3
+ uses: actions/upload-artifact@v4
if: matrix.node-version == '18.x'
with:
- name: dspace-angular coverage report
+ name: coverage-report-${{ matrix.node-version }}
path: 'coverage/dspace-angular/lcov.info'
retention-days: 14
- # Using docker-compose start backend using CI configuration
+ # Login to our Docker registry, so that we can access private Docker images using "docker compose" below.
+ - name: Login to ${{ env.DOCKER_REGISTRY }}
+ uses: docker/login-action@v3
+ with:
+ registry: ${{ env.DOCKER_REGISTRY }}
+ username: ${{ github.repository_owner }}
+ password: ${{ secrets.GITHUB_TOKEN }}
+
+ # Using "docker compose" start backend using CI configuration
# and load assetstore from a cached copy
- name: Start DSpace REST Backend via Docker (for e2e tests)
run: |
- docker-compose -f ./docker/docker-compose-ci.yml up -d
- docker-compose -f ./docker/cli.yml -f ./docker/cli.assetstore.yml run --rm dspace-cli
+ docker compose -f ./docker/docker-compose-ci.yml up -d
+ docker compose -f ./docker/cli.yml -f ./docker/cli.assetstore.yml run --rm dspace-cli
docker container ls
# Run integration tests via Cypress.io
# https://github.com/cypress-io/github-action
# (NOTE: to run these e2e tests locally, just use 'ng e2e')
- name: Run e2e tests (integration tests)
- uses: cypress-io/github-action@v5
+ uses: cypress-io/github-action@v6
with:
# Run tests in Chrome, headless mode (default)
browser: chrome
@@ -133,19 +147,19 @@ jobs:
# Cypress always creates a video of all e2e tests (whether they succeeded or failed)
# Save those in an Artifact
- name: Upload e2e test videos to Artifacts
- uses: actions/upload-artifact@v3
+ uses: actions/upload-artifact@v4
if: always()
with:
- name: e2e-test-videos
+ name: e2e-test-videos-${{ matrix.node-version }}
path: cypress/videos
# If e2e tests fail, Cypress creates a screenshot of what happened
# Save those in an Artifact
- name: Upload e2e test failure screenshots to Artifacts
- uses: actions/upload-artifact@v3
+ uses: actions/upload-artifact@v4
if: failure()
with:
- name: e2e-test-screenshots
+ name: e2e-test-screenshots-${{ matrix.node-version }}
path: cypress/screenshots
- name: Stop app (in case it stays up after e2e tests)
@@ -170,17 +184,120 @@ jobs:
# Get homepage and verify that the tag includes "DSpace".
# If it does, then SSR is working, as this tag is created by our MetadataService.
# This step also prints entire HTML of homepage for easier debugging if grep fails.
- - name: Verify SSR (server-side rendering)
+ - name: Verify SSR (server-side rendering) on Homepage
run: |
result=$(wget -O- -q http://127.0.0.1:4000/home)
echo "$result"
echo "$result" | grep -oE "]*>" | grep DSpace
+ # Get a specific community in our test data and verify that the "
" tag includes "Publications" (the community name).
+ # If it does, then SSR is working.
+ - name: Verify SSR on a Community page
+ run: |
+ result=$(wget -O- -q http://127.0.0.1:4000/communities/0958c910-2037-42a9-81c7-dca80e3892b4)
+ echo "$result"
+ echo "$result" | grep -oE "
]*>[^><]*
" | grep Publications
+
+ # Get a specific collection in our test data and verify that the "
" tag includes "Articles" (the collection name).
+ # If it does, then SSR is working.
+ - name: Verify SSR on a Collection page
+ run: |
+ result=$(wget -O- -q http://127.0.0.1:4000/collections/282164f5-d325-4740-8dd1-fa4d6d3e7200)
+ echo "$result"
+ echo "$result" | grep -oE "
]*>[^><]*
" | grep Articles
+
+ # Get a specific publication in our test data and verify that the tag includes
+ # the title of this publication. If it does, then SSR is working.
+ - name: Verify SSR on a Publication page
+ run: |
+ result=$(wget -O- -q http://127.0.0.1:4000/entities/publication/6160810f-1e53-40db-81ef-f6621a727398)
+ echo "$result"
+ echo "$result" | grep -oE "]*>" | grep "An Economic Model of Mortality Salience"
+
+ # Get a specific person in our test data and verify that the tag includes
+ # the name of the person. If it does, then SSR is working.
+ - name: Verify SSR on a Person page
+ run: |
+ result=$(wget -O- -q http://127.0.0.1:4000/entities/person/b1b2c768-bda1-448a-a073-fc541e8b24d9)
+ echo "$result"
+ echo "$result" | grep -oE "]*>" | grep "Simmons, Cameron"
+
+ # Get a specific project in our test data and verify that the tag includes
+ # the name of the project. If it does, then SSR is working.
+ - name: Verify SSR on a Project page
+ run: |
+ result=$(wget -O- -q http://127.0.0.1:4000/entities/project/46ccb608-a74c-4bf6-bc7a-e29cc7defea9)
+ echo "$result"
+ echo "$result" | grep -oE "]*>" | grep "University Research Fellowship"
+
+ # Get a specific orgunit in our test data and verify that the tag includes
+ # the name of the orgunit. If it does, then SSR is working.
+ - name: Verify SSR on an OrgUnit page
+ run: |
+ result=$(wget -O- -q http://127.0.0.1:4000/entities/orgunit/9851674d-bd9a-467b-8d84-068deb568ccf)
+ echo "$result"
+ echo "$result" | grep -oE "]*>" | grep "Law and Development"
+
+ # Get a specific journal in our test data and verify that the tag includes
+ # the name of the journal. If it does, then SSR is working.
+ - name: Verify SSR on a Journal page
+ run: |
+ result=$(wget -O- -q http://127.0.0.1:4000/entities/journal/d4af6c3e-53d0-4757-81eb-566f3b45d63a)
+ echo "$result"
+ echo "$result" | grep -oE "]*>" | grep "Environmental & Architectural Phenomenology"
+
+ # Get a specific journal volume in our test data and verify that the tag includes
+ # the name of the volume. If it does, then SSR is working.
+ - name: Verify SSR on a Journal Volume page
+ run: |
+ result=$(wget -O- -q http://127.0.0.1:4000/entities/journalvolume/07c6249f-4bf7-494d-9ce3-6ffdb2aed538)
+ echo "$result"
+ echo "$result" | grep -oE "]*>" | grep "Environmental & Architectural Phenomenology Volume 28 (2017)"
+
+ # Get a specific journal issue in our test data and verify that the tag includes
+ # the name of the issue. If it does, then SSR is working.
+ - name: Verify SSR on a Journal Issue page
+ run: |
+ result=$(wget -O- -q http://127.0.0.1:4000/entities/journalissue/44c29473-5de2-48fa-b005-e5029aa1a50b)
+ echo "$result"
+ echo "$result" | grep -oE "]*>" | grep "Environmental & Architectural Phenomenology Vol. 28, No. 1"
+
+ # Verify 301 Handle redirect behavior
+ # Note: /handle/123456789/260 is the same test Publication used by our e2e tests
+ - name: Verify 301 redirect from '/handle' URLs
+ run: |
+ result=$(wget --server-response --quiet http://127.0.0.1:4000/handle/123456789/260 2>&1 | head -1 | awk '{print $2}')
+ echo "$result"
+ [[ "$result" -eq "301" ]]
+
+ # Verify 403 error code behavior
+ - name: Verify 403 error code from '/403'
+ run: |
+ result=$(wget --server-response --quiet http://127.0.0.1:4000/403 2>&1 | head -1 | awk '{print $2}')
+ echo "$result"
+ [[ "$result" -eq "403" ]]
+
+ # Verify 404 error code behavior
+ - name: Verify 404 error code from '/404' and on invalid pages
+ run: |
+ result=$(wget --server-response --quiet http://127.0.0.1:4000/404 2>&1 | head -1 | awk '{print $2}')
+ echo "$result"
+ result2=$(wget --server-response --quiet http://127.0.0.1:4000/invalidurl 2>&1 | head -1 | awk '{print $2}')
+ echo "$result2"
+ [[ "$result" -eq "404" && "$result2" -eq "404" ]]
+
+ # Verify 500 error code behavior
+ - name: Verify 500 error code from '/500'
+ run: |
+ result=$(wget --server-response --quiet http://127.0.0.1:4000/500 2>&1 | head -1 | awk '{print $2}')
+ echo "$result"
+ [[ "$result" -eq "500" ]]
+
- name: Stop running app
run: kill -9 $(lsof -t -i:4000)
- name: Shutdown Docker containers
- run: docker-compose -f ./docker/docker-compose-ci.yml down
+ run: docker compose -f ./docker/docker-compose-ci.yml down
# Codecov upload is a separate job in order to allow us to restart this separate from the entire build/test
# job above. This is necessary because Codecov uploads seem to randomly fail at times.
@@ -191,11 +308,11 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
- uses: actions/checkout@v3
+ uses: actions/checkout@v4
# Download artifacts from previous 'tests' job
- name: Download coverage artifacts
- uses: actions/download-artifact@v3
+ uses: actions/download-artifact@v4
# Now attempt upload to Codecov using its action.
# NOTE: We use a retry action to retry the Codecov upload if it fails the first time.
@@ -203,10 +320,15 @@ jobs:
# Retry action: https://github.com/marketplace/actions/retry-action
# Codecov action: https://github.com/codecov/codecov-action
- name: Upload coverage to Codecov.io
- uses: Wandalen/wretry.action@v1.0.36
+ uses: Wandalen/wretry.action@v1.3.0
with:
- action: codecov/codecov-action@v3
- # Try upload 5 times max
+ action: codecov/codecov-action@v4
+ # Ensure codecov-action throws an error when it fails to upload
+ # This allows us to auto-restart the action if an error is thrown
+ with: |
+ fail_ci_if_error: true
+ token: ${{ secrets.CODECOV_TOKEN }}
+ # Try re-running action 5 times max
attempt_limit: 5
# Run again in 30 seconds
attempt_delay: 30000
diff --git a/.github/workflows/codescan.yml b/.github/workflows/codescan.yml
index 35a2e2d24a..d96e786cc3 100644
--- a/.github/workflows/codescan.yml
+++ b/.github/workflows/codescan.yml
@@ -5,12 +5,16 @@
# because CodeQL requires a fresh build with all tests *disabled*.
name: "Code Scanning"
-# Run this code scan for all pushes / PRs to main branch. Also run once a week.
+# Run this code scan for all pushes / PRs to main or maintenance branches. Also run once a week.
on:
push:
- branches: [ main ]
+ branches:
+ - main
+ - 'dspace-**'
pull_request:
- branches: [ main ]
+ branches:
+ - main
+ - 'dspace-**'
# Don't run if PR is only updating static documentation
paths-ignore:
- '**/*.md'
@@ -31,7 +35,7 @@ jobs:
steps:
# https://github.com/actions/checkout
- name: Checkout repository
- uses: actions/checkout@v3
+ uses: actions/checkout@v4
# Initializes the CodeQL tools for scanning.
# https://github.com/github/codeql-action
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
index 9a2c838d83..c9671bcac0 100644
--- a/.github/workflows/docker.yml
+++ b/.github/workflows/docker.yml
@@ -3,6 +3,9 @@ name: Docker images
# Run this Build for all pushes to 'main' or maintenance branches, or tagged releases.
# Also run for PRs to ensure PR doesn't break Docker build process
+# NOTE: uses "reusable-docker-build.yml" in DSpace/DSpace to actually build each of the Docker images
+# https://github.com/DSpace/DSpace/blob/dspace-7_x/.github/workflows/reusable-docker-build.yml
+#
on:
push:
branches:
@@ -13,108 +16,45 @@ on:
pull_request:
permissions:
- contents: read # to fetch code (actions/checkout)
+ contents: read # to fetch code (actions/checkout)
+ packages: write # to write images to GitHub Container Registry (GHCR)
jobs:
- docker:
+ #############################################################
+ # Build/Push the 'dspace/dspace-angular' image
+ #############################################################
+ dspace-angular:
# Ensure this job never runs on forked repos. It's only executed for 'dspace/dspace-angular'
if: github.repository == 'dspace/dspace-angular'
- runs-on: ubuntu-latest
- env:
- # Define tags to use for Docker images based on Git tags/branches (for docker/metadata-action)
- # For a new commit on default branch (main), use the literal tag 'dspace-7_x' on Docker image.
- # For a new commit on other branches, use the branch name as the tag for Docker image.
- # For a new tag, copy that tag name as the tag for Docker image.
- IMAGE_TAGS: |
- type=raw,value=dspace-7_x,enable=${{ endsWith(github.ref, github.event.repository.default_branch) }}
- type=ref,event=branch,enable=${{ !endsWith(github.ref, github.event.repository.default_branch) }}
- type=ref,event=tag
- # Define default tag "flavor" for docker/metadata-action per
- # https://github.com/docker/metadata-action#flavor-input
- # We turn off 'latest' tag by default.
- TAGS_FLAVOR: |
- latest=false
- # Architectures / Platforms for which we will build Docker images
- # If this is a PR, we ONLY build for AMD64. For PRs we only do a sanity check test to ensure Docker builds work.
- # If this is NOT a PR (e.g. a tag or merge commit), also build for ARM64.
- PLATFORMS: linux/amd64${{ github.event_name != 'pull_request' && ', linux/arm64' || '' }}
+ # Use the reusable-docker-build.yml script from DSpace/DSpace repo to build our Docker image
+ uses: DSpace/DSpace/.github/workflows/reusable-docker-build.yml@dspace-7_x
+ with:
+ build_id: dspace-angular-dev
+ image_name: dspace/dspace-angular
+ dockerfile_path: ./Dockerfile
+ secrets:
+ DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+ DOCKER_ACCESS_TOKEN: ${{ secrets.DOCKER_ACCESS_TOKEN }}
- steps:
- # https://github.com/actions/checkout
- - name: Checkout codebase
- uses: actions/checkout@v3
-
- # https://github.com/docker/setup-buildx-action
- - name: Setup Docker Buildx
- uses: docker/setup-buildx-action@v2
-
- # https://github.com/docker/setup-qemu-action
- - name: Set up QEMU emulation to build for multiple architectures
- uses: docker/setup-qemu-action@v2
-
- # https://github.com/docker/login-action
- - name: Login to DockerHub
- # Only login if not a PR, as PRs only trigger a Docker build and not a push
- if: github.event_name != 'pull_request'
- uses: docker/login-action@v2
- with:
- username: ${{ secrets.DOCKER_USERNAME }}
- password: ${{ secrets.DOCKER_ACCESS_TOKEN }}
-
- ###############################################
- # Build/Push the 'dspace/dspace-angular' image
- ###############################################
- # https://github.com/docker/metadata-action
- # Get Metadata for docker_build step below
- - name: Sync metadata (tags, labels) from GitHub to Docker for 'dspace-angular' image
- id: meta_build
- uses: docker/metadata-action@v4
- with:
- images: dspace/dspace-angular
- tags: ${{ env.IMAGE_TAGS }}
- flavor: ${{ env.TAGS_FLAVOR }}
-
- # https://github.com/docker/build-push-action
- - name: Build and push 'dspace-angular' image
- id: docker_build
- uses: docker/build-push-action@v3
- with:
- context: .
- file: ./Dockerfile
- platforms: ${{ env.PLATFORMS }}
- # For pull requests, we run the Docker build (to ensure no PR changes break the build),
- # but we ONLY do an image push to DockerHub if it's NOT a PR
- push: ${{ github.event_name != 'pull_request' }}
- # Use tags / labels provided by 'docker/metadata-action' above
- tags: ${{ steps.meta_build.outputs.tags }}
- labels: ${{ steps.meta_build.outputs.labels }}
-
- #####################################################
- # Build/Push the 'dspace/dspace-angular' image ('-dist' tag)
- #####################################################
- # https://github.com/docker/metadata-action
- # Get Metadata for docker_build_dist step below
- - name: Sync metadata (tags, labels) from GitHub to Docker for 'dspace-angular-dist' image
- id: meta_build_dist
- uses: docker/metadata-action@v4
- with:
- images: dspace/dspace-angular
- tags: ${{ env.IMAGE_TAGS }}
- # As this is a "dist" image, its tags are all suffixed with "-dist". Otherwise, it uses the same
- # tagging logic as the primary 'dspace/dspace-angular' image above.
- flavor: ${{ env.TAGS_FLAVOR }}
- suffix=-dist
-
- - name: Build and push 'dspace-angular-dist' image
- id: docker_build_dist
- uses: docker/build-push-action@v3
- with:
- context: .
- file: ./Dockerfile.dist
- platforms: ${{ env.PLATFORMS }}
- # For pull requests, we run the Docker build (to ensure no PR changes break the build),
- # but we ONLY do an image push to DockerHub if it's NOT a PR
- push: ${{ github.event_name != 'pull_request' }}
- # Use tags / labels provided by 'docker/metadata-action' above
- tags: ${{ steps.meta_build_dist.outputs.tags }}
- labels: ${{ steps.meta_build_dist.outputs.labels }}
+ #############################################################
+ # Build/Push the 'dspace/dspace-angular' image ('-dist' tag)
+ #############################################################
+ dspace-angular-dist:
+ # Ensure this job never runs on forked repos. It's only executed for 'dspace/dspace-angular'
+ if: github.repository == 'dspace/dspace-angular'
+ # Use the reusable-docker-build.yml script from DSpace/DSpace repo to build our Docker image
+ uses: DSpace/DSpace/.github/workflows/reusable-docker-build.yml@dspace-7_x
+ with:
+ build_id: dspace-angular-dist
+ image_name: dspace/dspace-angular
+ dockerfile_path: ./Dockerfile.dist
+ # As this is a "dist" image, its tags are all suffixed with "-dist". Otherwise, it uses the same
+ # tagging logic as the primary 'dspace/dspace-angular' image above.
+ tags_flavor: suffix=-dist
+ secrets:
+ DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+ DOCKER_ACCESS_TOKEN: ${{ secrets.DOCKER_ACCESS_TOKEN }}
+ # Enable redeploy of sandbox & demo if the branch for this image matches the deployment branch of
+ # these sites as specified in reusable-docker-build.xml
+ REDEPLOY_SANDBOX_URL: ${{ secrets.REDEPLOY_SANDBOX_URL }}
+ REDEPLOY_DEMO_URL: ${{ secrets.REDEPLOY_DEMO_URL }}
\ No newline at end of file
diff --git a/.github/workflows/issue_opened.yml b/.github/workflows/issue_opened.yml
index b4436dca3a..0a35a6a950 100644
--- a/.github/workflows/issue_opened.yml
+++ b/.github/workflows/issue_opened.yml
@@ -16,7 +16,7 @@ jobs:
# Only add to project board if issue is flagged as "needs triage" or has no labels
# NOTE: By default we flag new issues as "needs triage" in our issue template
if: (contains(github.event.issue.labels.*.name, 'needs triage') || join(github.event.issue.labels.*.name) == '')
- uses: actions/add-to-project@v0.5.0
+ uses: actions/add-to-project@v1.0.0
# Note, the authentication token below is an ORG level Secret.
# It must be created/recreated manually via a personal access token with admin:org, project, public_repo permissions
# See: https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#permissions-for-the-github_token
diff --git a/.github/workflows/label_merge_conflicts.yml b/.github/workflows/label_merge_conflicts.yml
index c1396b6f45..ccc6c401c0 100644
--- a/.github/workflows/label_merge_conflicts.yml
+++ b/.github/workflows/label_merge_conflicts.yml
@@ -1,11 +1,12 @@
# This workflow checks open PRs for merge conflicts and labels them when conflicts are found
name: Check for merge conflicts
-# Run whenever the "main" branch is updated
-# NOTE: This means merge conflicts are only checked for when a PR is merged to main.
+# Run this for all pushes (i.e. merges) to 'main' or maintenance branches
on:
push:
- branches: [ main ]
+ branches:
+ - main
+ - 'dspace-**'
# So that the `conflict_label_name` is removed if conflicts are resolved,
# we allow this to run for `pull_request_target` so that github secrets are available.
pull_request_target:
@@ -24,6 +25,8 @@ jobs:
# See: https://github.com/prince-chrismc/label-merge-conflicts-action
- name: Auto-label PRs with merge conflicts
uses: prince-chrismc/label-merge-conflicts-action@v3
+ # Ignore any failures -- may occur (randomly?) for older, outdated PRs.
+ continue-on-error: true
# Add "merge conflict" label if a merge conflict is detected. Remove it when resolved.
# Note, the authentication token is created automatically
# See: https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token
diff --git a/.github/workflows/port_merged_pull_request.yml b/.github/workflows/port_merged_pull_request.yml
new file mode 100644
index 0000000000..857f22755e
--- /dev/null
+++ b/.github/workflows/port_merged_pull_request.yml
@@ -0,0 +1,46 @@
+# This workflow will attempt to port a merged pull request to
+# the branch specified in a "port to" label (if exists)
+name: Port merged Pull Request
+
+# Only run for merged PRs against the "main" or maintenance branches
+# We allow this to run for `pull_request_target` so that github secrets are available
+# (This is required when the PR comes from a forked repo)
+on:
+ pull_request_target:
+ types: [ closed ]
+ branches:
+ - main
+ - 'dspace-**'
+
+permissions:
+ contents: write # so action can add comments
+ pull-requests: write # so action can create pull requests
+
+jobs:
+ port_pr:
+ runs-on: ubuntu-latest
+ # Don't run on closed *unmerged* pull requests
+ if: github.event.pull_request.merged
+ steps:
+ # Checkout code
+ - uses: actions/checkout@v4
+ # Port PR to other branch (ONLY if labeled with "port to")
+ # See https://github.com/korthout/backport-action
+ - name: Create backport pull requests
+ uses: korthout/backport-action@v2
+ with:
+ # Trigger based on a "port to [branch]" label on PR
+ # (This label must specify the branch name to port to)
+ label_pattern: '^port to ([^ ]+)$'
+ # Title to add to the (newly created) port PR
+ pull_title: '[Port ${target_branch}] ${pull_title}'
+ # Description to add to the (newly created) port PR
+ pull_description: 'Port of #${pull_number} by @${pull_author} to `${target_branch}`.'
+ # Copy all labels from original PR to (newly created) port PR
+ # NOTE: The labels matching 'label_pattern' are automatically excluded
+ copy_labels_pattern: '.*'
+ # Skip any merge commits in the ported PR. This means only non-merge commits are cherry-picked to the new PR
+ merge_commits: 'skip'
+ # Use a personal access token (PAT) to create PR as 'dspace-bot' user.
+ # A PAT is required in order for the new PR to trigger its own actions (for CI checks)
+ github_token: ${{ secrets.PR_PORT_TOKEN }}
\ No newline at end of file
diff --git a/.github/workflows/pull_request_opened.yml b/.github/workflows/pull_request_opened.yml
new file mode 100644
index 0000000000..bbac52af24
--- /dev/null
+++ b/.github/workflows/pull_request_opened.yml
@@ -0,0 +1,24 @@
+# This workflow runs whenever a new pull request is created
+name: Pull Request opened
+
+# Only run for newly opened PRs against the "main" or maintenance branches
+# We allow this to run for `pull_request_target` so that github secrets are available
+# (This is required to assign a PR back to the creator when the PR comes from a forked repo)
+on:
+ pull_request_target:
+ types: [ opened ]
+ branches:
+ - main
+ - 'dspace-**'
+
+permissions:
+ pull-requests: write
+
+jobs:
+ automation:
+ runs-on: ubuntu-latest
+ steps:
+ # Assign the PR to whomever created it. This is useful for visualizing assignments on project boards
+ # See https://github.com/toshimaru/auto-author-assign
+ - name: Assign PR to creator
+ uses: toshimaru/auto-author-assign@v2.1.0
diff --git a/Dockerfile b/Dockerfile
index 8fac7495e1..e395e4b90e 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,7 +1,7 @@
# This image will be published as dspace/dspace-angular
# See https://github.com/DSpace/dspace-angular/tree/main/docker for usage details
-FROM node:18-alpine
+FROM docker.io/node:18-alpine
# Ensure Python and other build tools are available
# These are needed to install some node modules, especially on linux/arm64
@@ -24,5 +24,5 @@ ENV NODE_OPTIONS="--max_old_space_size=4096"
# Listen / accept connections from all IP addresses.
# NOTE: At this time it is only possible to run Docker container in Production mode
# if you have a public URL. See https://github.com/DSpace/dspace-angular/issues/1485
-ENV NODE_ENV development
+ENV NODE_ENV=development
CMD yarn serve --host 0.0.0.0
diff --git a/Dockerfile.dist b/Dockerfile.dist
index 2a6a66fc06..c3ea539e04 100644
--- a/Dockerfile.dist
+++ b/Dockerfile.dist
@@ -4,7 +4,7 @@
# Test build:
# docker build -f Dockerfile.dist -t dspace/dspace-angular:dspace-7_x-dist .
-FROM node:18-alpine as build
+FROM docker.io/node:18-alpine AS build
# Ensure Python and other build tools are available
# These are needed to install some node modules, especially on linux/arm64
@@ -26,6 +26,6 @@ COPY --chown=node:node docker/dspace-ui.json /app/dspace-ui.json
WORKDIR /app
USER node
-ENV NODE_ENV production
+ENV NODE_ENV=production
EXPOSE 4000
CMD pm2-runtime start dspace-ui.json --json
diff --git a/README.md b/README.md
index 689c64a292..ebc24f8b91 100644
--- a/README.md
+++ b/README.md
@@ -157,8 +157,8 @@ DSPACE_UI_SSL => DSPACE_SSL
The same settings can also be overwritten by setting system environment variables instead, E.g.:
```bash
-export DSPACE_HOST=api7.dspace.org
-export DSPACE_UI_PORT=4200
+export DSPACE_HOST=demo.dspace.org
+export DSPACE_UI_PORT=4000
```
The priority works as follows: **environment variable** overrides **variable in `.env` file** overrides external config set by `DSPACE_APP_CONFIG_PATH` overrides **`config.(prod or dev).yml`**
@@ -288,7 +288,7 @@ E2E tests (aka integration tests) use [Cypress.io](https://www.cypress.io/). Con
The test files can be found in the `./cypress/integration/` folder.
Before you can run e2e tests, two things are REQUIRED:
-1. You MUST be running the DSpace backend (i.e. REST API) locally. The e2e tests will *NOT* succeed if run against our demo REST API (https://api7.dspace.org/server/), as that server is uncontrolled and may have content added/removed at any time.
+1. You MUST be running the DSpace backend (i.e. REST API) locally. The e2e tests will *NOT* succeed if run against our demo/sandbox REST API (https://demo.dspace.org/server/ or https://sandbox.dspace.org/server/), as those sites may have content added/removed at any time.
* After starting up your backend on localhost, make sure either your `config.prod.yml` or `config.dev.yml` has its `rest` settings defined to use that localhost backend.
* If you'd prefer, you may instead use environment variables as described at [Configuring](#configuring). For example:
```
diff --git a/angular.json b/angular.json
index 5e597d4d30..afda50a320 100644
--- a/angular.json
+++ b/angular.json
@@ -30,7 +30,6 @@
"lodash",
"jwt-decode",
"uuid",
- "webfontloader",
"zone.js"
],
"outputPath": "dist/browser",
diff --git a/config/config.example.yml b/config/config.example.yml
index ea38303fa3..ac2a645e25 100644
--- a/config/config.example.yml
+++ b/config/config.example.yml
@@ -1,7 +1,7 @@
# NOTE: will log all redux actions and transfers in console
debug: false
-# Angular Universal server settings
+# Angular User Inteface settings
# NOTE: these settings define where Node.js will start your UI application. Therefore, these
# "ui" settings usually specify a localhost port/URL which is later proxied to a public URL (using Apache or similar)
ui:
@@ -17,15 +17,61 @@ ui:
# Trust X-FORWARDED-* headers from proxies (default = true)
useProxies: true
+# Angular Universal / Server Side Rendering (SSR) settings
+universal:
+ # Whether to tell Angular to inline "critical" styles into the server-side rendered HTML.
+ # Determining which styles are critical is a relatively expensive operation; this option is
+ # disabled (false) by default to boost server performance at the expense of loading smoothness.
+ inlineCriticalCss: false
+ # Patterns to be run as regexes against the path of the page to check if SSR is allowed.
+ # If the path match any of the regexes it will be served directly in CSR.
+ # By default, excludes community and collection browse, global browse, global search, community list, statistics and various administrative tools.
+ excludePathPatterns:
+ - pattern: "^/communities/[a-f0-9-]{36}/browse(/.*)?$"
+ flag: "i"
+ - pattern: "^/collections/[a-f0-9-]{36}/browse(/.*)?$"
+ flag: "i"
+ - pattern: "^/browse/"
+ - pattern: "^/search$"
+ - pattern: "^/community-list$"
+ - pattern: "^/admin/"
+ - pattern: "^/processes/?"
+ - pattern: "^/notifications/"
+ - pattern: "^/statistics/?"
+ - pattern: "^/access-control/"
+ - pattern: "^/health$"
+
+ # Whether to enable rendering of Search component on SSR.
+ # If set to true the component will be included in the HTML returned from the server side rendering.
+ # If set to false the component will not be included in the HTML returned from the server side rendering.
+ enableSearchComponent: false
+ # Whether to enable rendering of Browse component on SSR.
+ # If set to true the component will be included in the HTML returned from the server side rendering.
+ # If set to false the component will not be included in the HTML returned from the server side rendering.
+ enableBrowseComponent: false
+ # Enable state transfer from the server-side application to the client-side application.
+ # Defaults to true.
+ # Note: When using an external application cache layer, it's recommended not to transfer the state to avoid caching it.
+ # Disabling it ensures that dynamic state information is not inadvertently cached, which can improve security and
+ # ensure that users always use the most up-to-date state.
+ transferState: true
+ # When a different REST base URL is used for the server-side application, the generated state contains references to
+ # REST resources with the internal URL configured. By default, these internal URLs are replaced with public URLs.
+ # Disable this setting to avoid URL replacement during SSR. In this the state is not transferred to avoid security issues.
+ replaceRestUrl: true
+
# The REST API server settings
# NOTE: these settings define which (publicly available) REST API to use. They are usually
# 'synced' with the 'dspace.server.url' setting in your backend's local.cfg.
rest:
ssl: true
- host: api7.dspace.org
+ host: demo.dspace.org
port: 443
# NOTE: Space is capitalized because 'namespace' is a reserved string in TypeScript
nameSpace: /server
+ # Provide a different REST url to be used during SSR execution. It must contain the whole url including protocol, server port and
+ # server namespace (uncomment to use it).
+ #ssrBaseUrl: http://localhost:8080/server
# Caching settings
cache:
@@ -75,7 +121,7 @@ cache:
anonymousCache:
# Maximum number of pages to cache. Default is zero (0) which means anonymous user cache is disabled.
# As all pages are cached in server memory, increasing this value will increase memory needs.
- # Individual cached pages are usually small (<100KB), so a value of max=1000 would only require ~100MB of memory.
+ # Individual cached pages are usually small (<100KB), so a value of max=1000 would only require ~100MB of memory.
max: 0
# Amount of time after which cached pages are considered stale (in ms). After becoming stale, the cached
# copy is automatically refreshed on the next request.
@@ -169,6 +215,12 @@ languages:
- code: en
label: English
active: true
+ - code: ar
+ label: العربية
+ active: true
+ - code: bn
+ label: বাংলা
+ active: true
- code: ca
label: Català
active: true
@@ -178,24 +230,36 @@ languages:
- code: de
label: Deutsch
active: true
+ - code: el
+ label: Ελληνικά
+ active: true
- code: es
label: Español
active: true
+ - code: fi
+ label: Suomi
+ active: true
- code: fr
label: Français
active: true
- code: gd
label: Gàidhlig
active: true
- - code: it
- label: Italiano
- active: true
- - code: lv
- label: Latviešu
+ - code: hi
+ label: हिंदी
active: true
- code: hu
label: Magyar
active: true
+ - code: it
+ label: Italiano
+ active: true
+ - code: kk
+ label: Қазақ
+ active: true
+ - code: lv
+ label: Latviešu
+ active: true
- code: nl
label: Nederlands
active: true
@@ -208,8 +272,11 @@ languages:
- code: pt-BR
label: Português do Brasil
active: true
- - code: fi
- label: Suomi
+ - code: sr-lat
+ label: Srpski (lat)
+ active: true
+ - code: sr-cyr
+ label: Српски
active: true
- code: sv
label: Svenska
@@ -217,24 +284,12 @@ languages:
- code: tr
label: Türkçe
active: true
- - code: vi
- label: Tiếng Việt
- active: true
- - code: kk
- label: Қазақ
- active: true
- - code: bn
- label: বাংলা
- active: true
- - code: hi
- label: हिंदी
- active: true
- - code: el
- label: Ελληνικά
- active: true
- code: uk
label: Yкраї́нська
active: true
+ - code: vi
+ label: Tiếng Việt
+ active: true
# Browse-By Pages
@@ -292,33 +347,33 @@ themes:
#
# # A theme with a handle property will match the community, collection or item with the given
# # handle, and all collections and/or items within it
- # - name: 'custom',
- # handle: '10673/1233'
+ # - name: custom
+ # handle: 10673/1233
#
# # A theme with a regex property will match the route using a regular expression. If it
# # matches the route for a community or collection it will also apply to all collections
# # and/or items within it
- # - name: 'custom',
- # regex: 'collections\/e8043bc2.*'
+ # - name: custom
+ # regex: collections\/e8043bc2.*
#
# # A theme with a uuid property will match the community, collection or item with the given
# # ID, and all collections and/or items within it
- # - name: 'custom',
- # uuid: '0958c910-2037-42a9-81c7-dca80e3892b4'
+ # - name: custom
+ # uuid: 0958c910-2037-42a9-81c7-dca80e3892b4
#
# # The extends property specifies an ancestor theme (by name). Whenever a themed component is not found
# # in the current theme, its ancestor theme(s) will be checked recursively before falling back to default.
- # - name: 'custom-A',
- # extends: 'custom-B',
+ # - name: custom-A
+ # extends: custom-B
# # Any of the matching properties above can be used
- # handle: '10673/34'
+ # handle: 10673/34
#
- # - name: 'custom-B',
- # extends: 'custom',
- # handle: '10673/12'
+ # - name: custom-B
+ # extends: custom
+ # handle: 10673/12
#
# # A theme with only a name will match every route
- # name: 'custom'
+ # name: custom
#
# # This theme will use the default bootstrap styling for DSpace components
# - name: BASE_THEME_NAME
@@ -376,7 +431,30 @@ vocabularies:
vocabulary: 'srsc'
enabled: true
-# Default collection/community sorting order at Advanced search, Create/update community and collection when there are not a query.
+# Default collection/community sorting order at Advanced search, Create/update community and collection when there are not a query.
comcolSelectionSort:
sortField: 'dc.title'
- sortDirection: 'ASC'
\ No newline at end of file
+ sortDirection: 'ASC'
+
+# Live Region configuration
+# Live Region as defined by w3c, https://www.w3.org/TR/wai-aria-1.1/#terms:
+# Live regions are perceivable regions of a web page that are typically updated as a
+# result of an external event when user focus may be elsewhere.
+#
+# The DSpace live region is a component present at the bottom of all pages that is invisible by default, but is useful
+# for screen readers. Any message pushed to the live region will be announced by the screen reader. These messages
+# usually contain information about changes on the page that might not be in focus.
+liveRegion:
+ # The duration after which messages disappear from the live region in milliseconds
+ messageTimeOutDurationMs: 30000
+ # The visibility of the live region. Setting this to true is only useful for debugging purposes.
+ isVisible: false
+
+
+# Search settings
+search:
+ # Number used to render n UI elements called loading skeletons that act as placeholders.
+ # These elements indicate that some content will be loaded in their stead.
+ # Since we don't know how many filters will be loaded before we receive a response from the server we use this parameter for the skeletons count.
+ # e.g. If we set 5 then 5 loading skeletons will be visualized before the actual filters are retrieved.
+ defaultFiltersCount: 5
diff --git a/config/config.yml b/config/config.yml
index b5eecd112f..dcf5389378 100644
--- a/config/config.yml
+++ b/config/config.yml
@@ -1,5 +1,5 @@
rest:
ssl: true
- host: api7.dspace.org
+ host: demo.dspace.org
port: 443
nameSpace: /server
diff --git a/cypress.config.ts b/cypress.config.ts
index 91eeb9838b..36d8120342 100644
--- a/cypress.config.ts
+++ b/cypress.config.ts
@@ -1,6 +1,7 @@
import { defineConfig } from 'cypress';
export default defineConfig({
+ video: true,
videosFolder: 'cypress/videos',
screenshotsFolder: 'cypress/screenshots',
fixturesFolder: 'cypress/fixtures',
@@ -9,27 +10,33 @@ export default defineConfig({
openMode: 0,
},
env: {
- // Global constants used in DSpace e2e tests (see also ./cypress/support/e2e.ts)
- // May be overridden in our cypress.json config file using specified environment variables.
+ // Global DSpace environment variables used in all our Cypress e2e tests
+ // May be modified in this config, or overridden in a variety of ways.
+ // See Cypress environment variable docs: https://docs.cypress.io/guides/guides/environment-variables
// Default values listed here are all valid for the Demo Entities Data set available at
// https://github.com/DSpace-Labs/AIP-Files/releases/tag/demo-entities-data
// (This is the data set used in our CI environment)
// Admin account used for administrative tests
DSPACE_TEST_ADMIN_USER: 'dspacedemo+admin@gmail.com',
+ DSPACE_TEST_ADMIN_USER_UUID: '335647b6-8a52-4ecb-a8c1-7ebabb199bda',
DSPACE_TEST_ADMIN_PASSWORD: 'dspace',
// Community/collection/publication used for view/edit tests
DSPACE_TEST_COMMUNITY: '0958c910-2037-42a9-81c7-dca80e3892b4',
DSPACE_TEST_COLLECTION: '282164f5-d325-4740-8dd1-fa4d6d3e7200',
- DSPACE_TEST_ENTITY_PUBLICATION: 'e98b0f27-5c19-49a0-960d-eb6ad5287067',
+ DSPACE_TEST_ENTITY_PUBLICATION: '6160810f-1e53-40db-81ef-f6621a727398',
// Search term (should return results) used in search tests
DSPACE_TEST_SEARCH_TERM: 'test',
- // Collection used for submission tests
+ // Main Collection used for submission tests. Should be able to accept normal Item objects
DSPACE_TEST_SUBMIT_COLLECTION_NAME: 'Sample Collection',
DSPACE_TEST_SUBMIT_COLLECTION_UUID: '9d8334e9-25d3-4a67-9cea-3dffdef80144',
+ // Collection used for Person entity submission tests. MUST be configured with EntityType=Person.
+ DSPACE_TEST_SUBMIT_PERSON_COLLECTION_NAME: 'People',
// Account used to test basic submission process
DSPACE_TEST_SUBMIT_USER: 'dspacedemo+submit@gmail.com',
DSPACE_TEST_SUBMIT_USER_PASSWORD: 'dspace',
+ // Administrator users group
+ DSPACE_ADMINISTRATOR_GROUP: 'e59f5659-bff9-451e-b28f-439e7bd467e4'
},
e2e: {
// Setup our plugins for e2e tests
diff --git a/cypress/e2e/admin-add-new-modals.cy.ts b/cypress/e2e/admin-add-new-modals.cy.ts
new file mode 100644
index 0000000000..332d44da13
--- /dev/null
+++ b/cypress/e2e/admin-add-new-modals.cy.ts
@@ -0,0 +1,54 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Admin Add New Modals', () => {
+ beforeEach(() => {
+ // Must login as an Admin for sidebar to appear
+ cy.visit('/login');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('Add new Community modal should pass accessibility tests', () => {
+ // Pin the sidebar open
+ cy.get('#sidebar-collapse-toggle').trigger('mouseover');
+ cy.get('#sidebar-collapse-toggle').click();
+
+ // Click on entry of menu
+ cy.get('#admin-menu-section-new-title').should('be.visible');
+ cy.get('#admin-menu-section-new-title').click();
+
+ cy.get('a[data-test="menu.section.new_community"]').click();
+
+ // Analyze for accessibility
+ testA11y('ds-create-community-parent-selector');
+ });
+
+ it('Add new Collection modal should pass accessibility tests', () => {
+ // Pin the sidebar open
+ cy.get('#sidebar-collapse-toggle').trigger('mouseover');
+ cy.get('#sidebar-collapse-toggle').click();
+
+ // Click on entry of menu
+ cy.get('#admin-menu-section-new-title').should('be.visible');
+ cy.get('#admin-menu-section-new-title').click();
+
+ cy.get('a[data-test="menu.section.new_collection"]').click();
+
+ // Analyze for accessibility
+ testA11y('ds-create-collection-parent-selector');
+ });
+
+ it('Add new Item modal should pass accessibility tests', () => {
+ // Pin the sidebar open
+ cy.get('#sidebar-collapse-toggle').trigger('mouseover');
+ cy.get('#sidebar-collapse-toggle').click();
+
+ // Click on entry of menu
+ cy.get('#admin-menu-section-new-title').should('be.visible');
+ cy.get('#admin-menu-section-new-title').click();
+
+ cy.get('a[data-test="menu.section.new_item"]').click();
+
+ // Analyze for accessibility
+ testA11y('ds-create-item-parent-selector');
+ });
+});
diff --git a/cypress/e2e/admin-curation-tasks.cy.ts b/cypress/e2e/admin-curation-tasks.cy.ts
new file mode 100644
index 0000000000..e66f0ccaad
--- /dev/null
+++ b/cypress/e2e/admin-curation-tasks.cy.ts
@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Admin Curation Tasks', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/admin/curation-tasks');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Page must first be visible
+ cy.get('ds-admin-curation-task').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-admin-curation-task');
+ });
+});
diff --git a/cypress/e2e/admin-edit-modals.cy.ts b/cypress/e2e/admin-edit-modals.cy.ts
new file mode 100644
index 0000000000..8ba524d5be
--- /dev/null
+++ b/cypress/e2e/admin-edit-modals.cy.ts
@@ -0,0 +1,54 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Admin Edit Modals', () => {
+ beforeEach(() => {
+ // Must login as an Admin for sidebar to appear
+ cy.visit('/login');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('Edit Community modal should pass accessibility tests', () => {
+ // Pin the sidebar open
+ cy.get('#sidebar-collapse-toggle').trigger('mouseover');
+ cy.get('#sidebar-collapse-toggle').click();
+
+ // Click on entry of menu
+ cy.get('#admin-menu-section-edit-title').should('be.visible');
+ cy.get('#admin-menu-section-edit-title').click();
+
+ cy.get('a[data-test="menu.section.edit_community"]').click();
+
+ // Analyze for accessibility
+ testA11y('ds-edit-community-selector');
+ });
+
+ it('Edit Collection modal should pass accessibility tests', () => {
+ // Pin the sidebar open
+ cy.get('#sidebar-collapse-toggle').trigger('mouseover');
+ cy.get('#sidebar-collapse-toggle').click();
+
+ // Click on entry of menu
+ cy.get('#admin-menu-section-edit-title').should('be.visible');
+ cy.get('#admin-menu-section-edit-title').click();
+
+ cy.get('a[data-test="menu.section.edit_collection"]').click();
+
+ // Analyze for accessibility
+ testA11y('ds-edit-collection-selector');
+ });
+
+ it('Edit Item modal should pass accessibility tests', () => {
+ // Pin the sidebar open
+ cy.get('#sidebar-collapse-toggle').trigger('mouseover');
+ cy.get('#sidebar-collapse-toggle').click();
+
+ // Click on entry of menu
+ cy.get('#admin-menu-section-edit-title').should('be.visible');
+ cy.get('#admin-menu-section-edit-title').click();
+
+ cy.get('a[data-test="menu.section.edit_item"]').click();
+
+ // Analyze for accessibility
+ testA11y('ds-edit-item-selector');
+ });
+});
diff --git a/cypress/e2e/admin-export-modals.cy.ts b/cypress/e2e/admin-export-modals.cy.ts
new file mode 100644
index 0000000000..24a184fd35
--- /dev/null
+++ b/cypress/e2e/admin-export-modals.cy.ts
@@ -0,0 +1,39 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Admin Export Modals', () => {
+ beforeEach(() => {
+ // Must login as an Admin for sidebar to appear
+ cy.visit('/login');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('Export metadata modal should pass accessibility tests', () => {
+ // Pin the sidebar open
+ cy.get('#sidebar-collapse-toggle').trigger('mouseover');
+ cy.get('#sidebar-collapse-toggle').click();
+
+ // Click on entry of menu
+ cy.get('#admin-menu-section-export-title').should('be.visible');
+ cy.get('#admin-menu-section-export-title').click();
+
+ cy.get('a[data-test="menu.section.export_metadata"]').click();
+
+ // Analyze for accessibility
+ testA11y('ds-export-metadata-selector');
+ });
+
+ it('Export batch modal should pass accessibility tests', () => {
+ // Pin the sidebar open
+ cy.get('#sidebar-collapse-toggle').trigger('mouseover');
+ cy.get('#sidebar-collapse-toggle').click();
+
+ // Click on entry of menu
+ cy.get('#admin-menu-section-export-title').should('be.visible');
+ cy.get('#admin-menu-section-export-title').click();
+
+ cy.get('a[data-test="menu.section.export_batch"]').click();
+
+ // Analyze for accessibility
+ testA11y('ds-export-metadata-selector');
+ });
+});
diff --git a/cypress/e2e/admin-search-page.cy.ts b/cypress/e2e/admin-search-page.cy.ts
new file mode 100644
index 0000000000..4fbf8939fe
--- /dev/null
+++ b/cypress/e2e/admin-search-page.cy.ts
@@ -0,0 +1,21 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Admin Search Page', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/admin/search');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ //Page must first be visible
+ cy.get('ds-admin-search-page').should('be.visible');
+ // At least one search result should be displayed
+ cy.get('[data-test="list-object"]').should('be.visible');
+ // Click each filter toggle to open *every* filter
+ // (As we want to scan filter section for accessibility issues as well)
+ cy.get('[data-test="filter-toggle"]').click({ multiple: true });
+ // Analyze for accessibility issues
+ testA11y('ds-admin-search-page');
+ });
+});
diff --git a/cypress/e2e/admin-sidebar.cy.ts b/cypress/e2e/admin-sidebar.cy.ts
new file mode 100644
index 0000000000..7612eb5313
--- /dev/null
+++ b/cypress/e2e/admin-sidebar.cy.ts
@@ -0,0 +1,28 @@
+import { Options } from 'cypress-axe';
+import { testA11y } from 'cypress/support/utils';
+
+describe('Admin Sidebar', () => {
+ beforeEach(() => {
+ // Must login as an Admin for sidebar to appear
+ cy.visit('/login');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should be pinnable and pass accessibility tests', () => {
+ // Pin the sidebar open
+ cy.get('#sidebar-collapse-toggle').click();
+
+ // Click on every expandable section to open all menus
+ cy.get('ds-expandable-admin-sidebar-section').click({multiple: true});
+
+ // Analyze for accessibility
+ testA11y('ds-admin-sidebar',
+ {
+ rules: {
+ // Currently all expandable sections have nested interactive elements
+ // See https://github.com/DSpace/dspace-angular/issues/2178
+ 'nested-interactive': { enabled: false },
+ }
+ } as Options);
+ });
+});
diff --git a/cypress/e2e/admin-workflow-page.cy.ts b/cypress/e2e/admin-workflow-page.cy.ts
new file mode 100644
index 0000000000..c3c235e346
--- /dev/null
+++ b/cypress/e2e/admin-workflow-page.cy.ts
@@ -0,0 +1,21 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Admin Workflow Page', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/admin/workflow');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Page must first be visible
+ cy.get('ds-admin-workflow-page').should('be.visible');
+ // At least one search result should be displayed
+ cy.get('[data-test="list-object"]').should('be.visible');
+ // Click each filter toggle to open *every* filter
+ // (As we want to scan filter section for accessibility issues as well)
+ cy.get('[data-test="filter-toggle"]').click({ multiple: true });
+ // Analyze for accessibility issues
+ testA11y('ds-admin-workflow-page');
+ });
+});
diff --git a/cypress/e2e/batch-import-page.cy.ts b/cypress/e2e/batch-import-page.cy.ts
new file mode 100644
index 0000000000..871b8644ce
--- /dev/null
+++ b/cypress/e2e/batch-import-page.cy.ts
@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Batch Import Page', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see processes
+ cy.visit('/admin/batch-import');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Batch import form must first be visible
+ cy.get('ds-batch-import-page').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-batch-import-page');
+ });
+});
diff --git a/cypress/e2e/bitstreams-format.cy.ts b/cypress/e2e/bitstreams-format.cy.ts
new file mode 100644
index 0000000000..f113d45ebc
--- /dev/null
+++ b/cypress/e2e/bitstreams-format.cy.ts
@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Bitstreams Formats', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/admin/registries/bitstream-formats');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Page must first be visible
+ cy.get('ds-bitstream-formats').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-bitstream-formats');
+ });
+});
diff --git a/cypress/e2e/breadcrumbs.cy.ts b/cypress/e2e/breadcrumbs.cy.ts
index ea6acdafcd..0cddbc723c 100644
--- a/cypress/e2e/breadcrumbs.cy.ts
+++ b/cypress/e2e/breadcrumbs.cy.ts
@@ -1,10 +1,9 @@
-import { TEST_ENTITY_PUBLICATION } from 'cypress/support/e2e';
import { testA11y } from 'cypress/support/utils';
describe('Breadcrumbs', () => {
it('should pass accessibility tests', () => {
// Visit an Item, as those have more breadcrumbs
- cy.visit('/entities/publication/'.concat(TEST_ENTITY_PUBLICATION));
+ cy.visit('/entities/publication/'.concat(Cypress.env('DSPACE_TEST_ENTITY_PUBLICATION')));
// Wait for breadcrumbs to be visible
cy.get('ds-breadcrumbs').should('be.visible');
diff --git a/cypress/e2e/bulk-access.cy.ts b/cypress/e2e/bulk-access.cy.ts
new file mode 100644
index 0000000000..87033e13e4
--- /dev/null
+++ b/cypress/e2e/bulk-access.cy.ts
@@ -0,0 +1,31 @@
+import { testA11y } from 'cypress/support/utils';
+import { Options } from 'cypress-axe';
+
+describe('Bulk Access', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/access-control/bulk-access');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Page must first be visible
+ cy.get('ds-bulk-access').should('be.visible');
+ // At least one search result should be displayed
+ cy.get('[data-test="list-object"]').should('be.visible');
+ // Click each filter toggle to open *every* filter
+ // (As we want to scan filter section for accessibility issues as well)
+ cy.get('[data-test="filter-toggle"]').click({ multiple: true });
+ // Analyze for accessibility issues
+ testA11y('ds-bulk-access', {
+ rules: {
+ // All panels are accordians & fail "aria-required-children" and "nested-interactive".
+ // Seem to require updating ng-bootstrap and https://github.com/DSpace/dspace-angular/issues/2216
+ 'aria-required-children': { enabled: false },
+ 'nested-interactive': { enabled: false },
+ // Card titles fail this test currently
+ 'heading-order': { enabled: false },
+ },
+ } as Options);
+ });
+});
diff --git a/cypress/e2e/collection-edit.cy.ts b/cypress/e2e/collection-edit.cy.ts
new file mode 100644
index 0000000000..63d873db3e
--- /dev/null
+++ b/cypress/e2e/collection-edit.cy.ts
@@ -0,0 +1,128 @@
+import { testA11y } from 'cypress/support/utils';
+
+const COLLECTION_EDIT_PAGE = '/collections/'.concat(Cypress.env('DSPACE_TEST_COLLECTION')).concat('/edit');
+
+beforeEach(() => {
+ // All tests start with visiting the Edit Collection Page
+ cy.visit(COLLECTION_EDIT_PAGE);
+
+ // This page is restricted, so we will be shown the login form. Fill it out & submit.
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+});
+
+describe('Edit Collection > Edit Metadata tab', () => {
+ it('should pass accessibility tests', () => {
+ // tag must be loaded
+ cy.get('ds-edit-collection').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-edit-collection');
+ });
+});
+
+describe('Edit Collection > Assign Roles tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="roles"]').click();
+
+ // tag must be loaded
+ cy.get('ds-collection-roles').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-collection-roles');
+ });
+});
+
+describe('Edit Collection > Content Source tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="source"]').click();
+
+ // tag must be loaded
+ cy.get('ds-collection-source').should('be.visible');
+
+ // Check the external source checkbox (to display all fields on the page)
+ cy.get('#externalSourceCheck').check();
+
+ // Wait for the source controls to appear
+ // cy.get('ds-collection-source-controls').should('be.visible');
+
+ // Analyze entire page for accessibility issues
+ testA11y('ds-collection-source');
+ });
+});
+
+describe('Edit Collection > Curate tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="curate"]').click();
+
+ // tag must be loaded
+ cy.get('ds-collection-curate').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-collection-curate');
+ });
+});
+
+describe('Edit Collection > Access Control tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="access-control"]').click();
+
+ // tag must be loaded
+ cy.get('ds-collection-access-control').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-collection-access-control');
+ });
+});
+
+describe('Edit Collection > Authorizations tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="authorizations"]').click();
+
+ // tag must be loaded
+ cy.get('ds-collection-authorizations').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-collection-authorizations');
+ });
+});
+
+describe('Edit Collection > Item Mapper tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="mapper"]').click();
+
+ // tag must be loaded
+ cy.get('ds-collection-item-mapper').should('be.visible');
+
+ // Analyze entire page for accessibility issues
+ testA11y('ds-collection-item-mapper');
+
+ // Click on the "Map new Items" tab
+ cy.get('li[data-test="mapTab"] a').click();
+
+ // Make sure search form is now visible
+ cy.get('ds-search-form').should('be.visible');
+
+ // Analyze entire page (again) for accessibility issues
+ testA11y('ds-collection-item-mapper');
+ });
+});
+
+
+describe('Edit Collection > Delete page', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="delete-button"]').click();
+
+ // tag must be loaded
+ cy.get('ds-delete-collection').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-delete-collection');
+ });
+});
diff --git a/cypress/e2e/collection-page.cy.ts b/cypress/e2e/collection-page.cy.ts
index a034b4361d..373da07888 100644
--- a/cypress/e2e/collection-page.cy.ts
+++ b/cypress/e2e/collection-page.cy.ts
@@ -1,15 +1,21 @@
-import { TEST_COLLECTION } from 'cypress/support/e2e';
import { testA11y } from 'cypress/support/utils';
describe('Collection Page', () => {
- it('should pass accessibility tests', () => {
- cy.visit('/collections/'.concat(TEST_COLLECTION));
+ it('should pass accessibility tests', () => {
+ cy.intercept('POST', '/server/api/statistics/viewevents').as('viewevent');
- // tag must be loaded
- cy.get('ds-collection-page').should('be.visible');
+ // Visit Collections page
+ cy.visit('/collections/'.concat(Cypress.env('DSPACE_TEST_COLLECTION')));
- // Analyze for accessibility issues
- testA11y('ds-collection-page');
- });
+ // Wait for the "viewevent" to trigger on the Collection page.
+ // This ensures our tag is fully loaded, as the tag is contained within it.
+ cy.wait('@viewevent');
+
+ // tag must be loaded
+ cy.get('ds-collection-page').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-collection-page');
+ });
});
diff --git a/cypress/e2e/collection-statistics.cy.ts b/cypress/e2e/collection-statistics.cy.ts
index 6df4e9a454..a08f8cb198 100644
--- a/cypress/e2e/collection-statistics.cy.ts
+++ b/cypress/e2e/collection-statistics.cy.ts
@@ -1,12 +1,12 @@
-import { REGEX_MATCH_NON_EMPTY_TEXT, TEST_COLLECTION } from 'cypress/support/e2e';
+import { REGEX_MATCH_NON_EMPTY_TEXT } from 'cypress/support/e2e';
import { testA11y } from 'cypress/support/utils';
describe('Collection Statistics Page', () => {
- const COLLECTIONSTATISTICSPAGE = '/statistics/collections/'.concat(TEST_COLLECTION);
+ const COLLECTIONSTATISTICSPAGE = '/statistics/collections/'.concat(Cypress.env('DSPACE_TEST_COLLECTION'));
it('should load if you click on "Statistics" from a Collection page', () => {
- cy.visit('/collections/'.concat(TEST_COLLECTION));
- cy.get('ds-navbar ds-link-menu-item a[title="Statistics"]').click();
+ cy.visit('/collections/'.concat(Cypress.env('DSPACE_TEST_COLLECTION')));
+ cy.get('ds-navbar ds-link-menu-item a[data-test="link-menu-item.menu.section.statistics"]').click();
cy.location('pathname').should('eq', COLLECTIONSTATISTICSPAGE);
});
@@ -18,7 +18,7 @@ describe('Collection Statistics Page', () => {
it('should contain a "Total visits per month" section', () => {
cy.visit(COLLECTIONSTATISTICSPAGE);
// Check just for existence because this table is empty in CI environment as it's historical data
- cy.get('.'.concat(TEST_COLLECTION).concat('_TotalVisitsPerMonth')).should('exist');
+ cy.get('.'.concat(Cypress.env('DSPACE_TEST_COLLECTION')).concat('_TotalVisitsPerMonth')).should('exist');
});
it('should pass accessibility tests', () => {
diff --git a/cypress/e2e/community-edit.cy.ts b/cypress/e2e/community-edit.cy.ts
new file mode 100644
index 0000000000..8fc1a7733e
--- /dev/null
+++ b/cypress/e2e/community-edit.cy.ts
@@ -0,0 +1,86 @@
+import { testA11y } from 'cypress/support/utils';
+
+const COMMUNITY_EDIT_PAGE = '/communities/'.concat(Cypress.env('DSPACE_TEST_COMMUNITY')).concat('/edit');
+
+beforeEach(() => {
+ // All tests start with visiting the Edit Community Page
+ cy.visit(COMMUNITY_EDIT_PAGE);
+
+ // This page is restricted, so we will be shown the login form. Fill it out & submit.
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+});
+
+describe('Edit Community > Edit Metadata tab', () => {
+ it('should pass accessibility tests', () => {
+ // tag must be loaded
+ cy.get('ds-edit-community').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-edit-community');
+ });
+});
+
+describe('Edit Community > Assign Roles tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="roles"]').click();
+
+ // tag must be loaded
+ cy.get('ds-community-roles').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-community-roles');
+ });
+});
+
+describe('Edit Community > Curate tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="curate"]').click();
+
+ // tag must be loaded
+ cy.get('ds-community-curate').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-community-curate');
+ });
+});
+
+describe('Edit Community > Access Control tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="access-control"]').click();
+
+ // tag must be loaded
+ cy.get('ds-community-access-control').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-community-access-control');
+ });
+});
+
+describe('Edit Community > Authorizations tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="authorizations"]').click();
+
+ // tag must be loaded
+ cy.get('ds-community-authorizations').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-community-authorizations');
+ });
+});
+
+describe('Edit Community > Delete page', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="delete-button"]').click();
+
+ // tag must be loaded
+ cy.get('ds-delete-community').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-delete-community');
+ });
+});
diff --git a/cypress/e2e/community-list.cy.ts b/cypress/e2e/community-list.cy.ts
index 7b60b59dbc..c371f6ceae 100644
--- a/cypress/e2e/community-list.cy.ts
+++ b/cypress/e2e/community-list.cy.ts
@@ -1,4 +1,3 @@
-import { Options } from 'cypress-axe';
import { testA11y } from 'cypress/support/utils';
describe('Community List Page', () => {
@@ -13,13 +12,6 @@ describe('Community List Page', () => {
cy.get('[data-test="expand-button"]').click({ multiple: true });
// Analyze for accessibility issues
- // Disable heading-order checks until it is fixed
- testA11y('ds-community-list-page',
- {
- rules: {
- 'heading-order': { enabled: false }
- }
- } as Options
- );
+ testA11y('ds-community-list-page');
});
});
diff --git a/cypress/e2e/community-page.cy.ts b/cypress/e2e/community-page.cy.ts
index 6c628e21ce..386bb592a0 100644
--- a/cypress/e2e/community-page.cy.ts
+++ b/cypress/e2e/community-page.cy.ts
@@ -1,15 +1,14 @@
-import { TEST_COMMUNITY } from 'cypress/support/e2e';
import { testA11y } from 'cypress/support/utils';
describe('Community Page', () => {
it('should pass accessibility tests', () => {
- cy.visit('/communities/'.concat(TEST_COMMUNITY));
+ cy.visit('/communities/'.concat(Cypress.env('DSPACE_TEST_COMMUNITY')));
// tag must be loaded
cy.get('ds-community-page').should('be.visible');
// Analyze for accessibility issues
- testA11y('ds-community-page',);
+ testA11y('ds-community-page');
});
});
diff --git a/cypress/e2e/community-statistics.cy.ts b/cypress/e2e/community-statistics.cy.ts
index 710450e797..8122e68fbb 100644
--- a/cypress/e2e/community-statistics.cy.ts
+++ b/cypress/e2e/community-statistics.cy.ts
@@ -1,12 +1,12 @@
-import { REGEX_MATCH_NON_EMPTY_TEXT, TEST_COMMUNITY } from 'cypress/support/e2e';
+import { REGEX_MATCH_NON_EMPTY_TEXT } from 'cypress/support/e2e';
import { testA11y } from 'cypress/support/utils';
describe('Community Statistics Page', () => {
- const COMMUNITYSTATISTICSPAGE = '/statistics/communities/'.concat(TEST_COMMUNITY);
+ const COMMUNITYSTATISTICSPAGE = '/statistics/communities/'.concat(Cypress.env('DSPACE_TEST_COMMUNITY'));
it('should load if you click on "Statistics" from a Community page', () => {
- cy.visit('/communities/'.concat(TEST_COMMUNITY));
- cy.get('ds-navbar ds-link-menu-item a[title="Statistics"]').click();
+ cy.visit('/communities/'.concat(Cypress.env('DSPACE_TEST_COMMUNITY')));
+ cy.get('a[data-test="link-menu-item.menu.section.statistics"]').click();
cy.location('pathname').should('eq', COMMUNITYSTATISTICSPAGE);
});
@@ -18,7 +18,7 @@ describe('Community Statistics Page', () => {
it('should contain a "Total visits per month" section', () => {
cy.visit(COMMUNITYSTATISTICSPAGE);
// Check just for existence because this table is empty in CI environment as it's historical data
- cy.get('.'.concat(TEST_COMMUNITY).concat('_TotalVisitsPerMonth')).should('exist');
+ cy.get('.'.concat(Cypress.env('DSPACE_TEST_COMMUNITY')).concat('_TotalVisitsPerMonth')).should('exist');
});
it('should pass accessibility tests', () => {
diff --git a/cypress/e2e/create-eperson.cy.ts b/cypress/e2e/create-eperson.cy.ts
new file mode 100644
index 0000000000..d23986ba29
--- /dev/null
+++ b/cypress/e2e/create-eperson.cy.ts
@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Create Eperson', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/access-control/epeople/create');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Form must first be visible
+ cy.get('ds-eperson-form').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-eperson-form');
+ });
+});
diff --git a/cypress/e2e/create-group.cy.ts b/cypress/e2e/create-group.cy.ts
new file mode 100644
index 0000000000..135c041a8d
--- /dev/null
+++ b/cypress/e2e/create-group.cy.ts
@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Create Group', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/access-control/groups/create');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Form must first be visible
+ cy.get('ds-group-form').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-group-form');
+ });
+});
diff --git a/cypress/e2e/edit-eperson.cy.ts b/cypress/e2e/edit-eperson.cy.ts
new file mode 100644
index 0000000000..166c913b8c
--- /dev/null
+++ b/cypress/e2e/edit-eperson.cy.ts
@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Edit Eperson', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/access-control/epeople/'.concat(Cypress.env('DSPACE_TEST_ADMIN_USER_UUID')).concat('/edit'));
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Form must first be visible
+ cy.get('ds-eperson-form').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-eperson-form');
+ });
+});
diff --git a/cypress/e2e/edit-group.cy.ts b/cypress/e2e/edit-group.cy.ts
new file mode 100644
index 0000000000..e43ede978a
--- /dev/null
+++ b/cypress/e2e/edit-group.cy.ts
@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Edit Group', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/access-control/groups/'.concat(Cypress.env('DSPACE_ADMINISTRATOR_GROUP')).concat('/edit'));
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Form must first be visible
+ cy.get('ds-group-form').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-group-form');
+ });
+});
diff --git a/cypress/e2e/end-user-agreement.cy.ts b/cypress/e2e/end-user-agreement.cy.ts
new file mode 100644
index 0000000000..989d21ce60
--- /dev/null
+++ b/cypress/e2e/end-user-agreement.cy.ts
@@ -0,0 +1,13 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('End User Agreement', () => {
+ it('should pass accessibility tests', () => {
+ cy.visit('/info/end-user-agreement');
+
+ // Page must first be visible
+ cy.get('ds-end-user-agreement').should('be.visible');
+
+ // Analyze for accessibility
+ testA11y('ds-end-user-agreement');
+ });
+});
diff --git a/cypress/e2e/epeople-registry.cy.ts b/cypress/e2e/epeople-registry.cy.ts
new file mode 100644
index 0000000000..a6192f13d9
--- /dev/null
+++ b/cypress/e2e/epeople-registry.cy.ts
@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Epeople registry', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/access-control/epeople');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Epeople registry page must first be visible
+ cy.get('ds-epeople-registry').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-epeople-registry');
+ });
+});
diff --git a/cypress/e2e/feedback.cy.ts b/cypress/e2e/feedback.cy.ts
new file mode 100644
index 0000000000..75fe1097c6
--- /dev/null
+++ b/cypress/e2e/feedback.cy.ts
@@ -0,0 +1,13 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Feedback', () => {
+ it('should pass accessibility tests', () => {
+ cy.visit('/info/feedback');
+
+ // Page must first be visible
+ cy.get('ds-feedback').should('be.visible');
+
+ // Analyze for accessibility
+ testA11y('ds-feedback');
+ });
+});
diff --git a/cypress/e2e/groups-registry.cy.ts b/cypress/e2e/groups-registry.cy.ts
new file mode 100644
index 0000000000..5c0099c2f1
--- /dev/null
+++ b/cypress/e2e/groups-registry.cy.ts
@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Groups registry', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/access-control/groups');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Epeople registry page must first be visible
+ cy.get('ds-groups-registry').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-groups-registry');
+ });
+});
diff --git a/cypress/e2e/header.cy.ts b/cypress/e2e/header.cy.ts
index 236208db68..c86fd39f1f 100644
--- a/cypress/e2e/header.cy.ts
+++ b/cypress/e2e/header.cy.ts
@@ -8,12 +8,31 @@ describe('Header', () => {
cy.get('ds-header').should('be.visible');
// Analyze for accessibility
- testA11y({
- include: ['ds-header'],
- exclude: [
- ['#search-navbar-container'], // search in navbar has duplicative ID. Will be fixed in #1174
- ['.dropdownLogin'] // "Log in" link has color contrast issues. Will be fixed in #1149
- ],
- });
+ testA11y('ds-header');
+ });
+
+ it('should allow for changing language to German (for example)', () => {
+ cy.visit('/');
+
+ // Click the language switcher (globe) in header
+ cy.get('a[data-test="lang-switch"]').click();
+ // Click on the "Deusch" language in dropdown
+ cy.get('#language-menu-list li').contains('Deutsch').click();
+
+ // HTML "lang" attribute should switch to "de"
+ cy.get('html').invoke('attr', 'lang').should('eq', 'de');
+
+ // Login menu should now be in German
+ cy.get('a[data-test="login-menu"]').contains('Anmelden');
+
+ // Change back to English from language switcher
+ cy.get('a[data-test="lang-switch"]').click();
+ cy.get('#language-menu-list li').contains('English').click();
+
+ // HTML "lang" attribute should switch to "en"
+ cy.get('html').invoke('attr', 'lang').should('eq', 'en');
+
+ // Login menu should now be in English
+ cy.get('a[data-test="login-menu"]').contains('Log In');
});
});
diff --git a/cypress/e2e/health-page.cy.ts b/cypress/e2e/health-page.cy.ts
new file mode 100644
index 0000000000..c702fa72d7
--- /dev/null
+++ b/cypress/e2e/health-page.cy.ts
@@ -0,0 +1,62 @@
+import { testA11y } from 'cypress/support/utils';
+import { Options } from 'cypress-axe';
+
+
+beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/health');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+});
+
+describe('Health Page > Status Tab', () => {
+ it('should pass accessibility tests', () => {
+ cy.intercept('GET', '/server/actuator/health').as('status');
+ cy.wait('@status');
+
+ cy.get('a[data-test="health-page.status-tab"]').click();
+ // Page must first be visible
+ cy.get('ds-health-page').should('be.visible');
+ cy.get('ds-health-panel').should('be.visible');
+
+ // wait for all the ds-health-info-component components to be rendered
+ cy.get('div[role="tabpanel"]').each(($panel: HTMLDivElement) => {
+ cy.wrap($panel).find('ds-health-component').should('be.visible');
+ });
+ // Analyze for accessibility issues
+ testA11y('ds-health-page', {
+ rules: {
+ // All panels are accordians & fail "aria-required-children" and "nested-interactive".
+ // Seem to require updating ng-bootstrap and https://github.com/DSpace/dspace-angular/issues/2216
+ 'aria-required-children': { enabled: false },
+ 'nested-interactive': { enabled: false },
+ },
+ } as Options);
+ });
+});
+
+describe('Health Page > Info Tab', () => {
+ it('should pass accessibility tests', () => {
+ cy.intercept('GET', '/server/actuator/info').as('info');
+ cy.wait('@info');
+
+ cy.get('a[data-test="health-page.info-tab"]').click();
+ // Page must first be visible
+ cy.get('ds-health-page').should('be.visible');
+ cy.get('ds-health-info').should('be.visible');
+
+ // wait for all the ds-health-info-component components to be rendered
+ cy.get('div[role="tabpanel"]').each(($panel: HTMLDivElement) => {
+ cy.wrap($panel).find('ds-health-info-component').should('be.visible');
+ });
+
+ // Analyze for accessibility issues
+ testA11y('ds-health-info', {
+ rules: {
+ // All panels are accordions & fail "aria-required-children" and "nested-interactive".
+ // Seem to require updating ng-bootstrap and https://github.com/DSpace/dspace-angular/issues/2216
+ 'aria-required-children': { enabled: false },
+ 'nested-interactive': { enabled: false },
+ },
+ } as Options);
+ });
+});
diff --git a/cypress/e2e/homepage-statistics.cy.ts b/cypress/e2e/homepage-statistics.cy.ts
index 2a1ab9785a..88daeeb2b9 100644
--- a/cypress/e2e/homepage-statistics.cy.ts
+++ b/cypress/e2e/homepage-statistics.cy.ts
@@ -1,18 +1,18 @@
-import { REGEX_MATCH_NON_EMPTY_TEXT, TEST_ENTITY_PUBLICATION } from 'cypress/support/e2e';
+import { REGEX_MATCH_NON_EMPTY_TEXT } from 'cypress/support/e2e';
import { testA11y } from 'cypress/support/utils';
import '../support/commands';
describe('Site Statistics Page', () => {
it('should load if you click on "Statistics" from homepage', () => {
cy.visit('/');
- cy.get('ds-navbar ds-link-menu-item a[title="Statistics"]').click();
+ cy.get('a[data-test="link-menu-item.menu.section.statistics"]').click();
cy.location('pathname').should('eq', '/statistics');
});
it('should pass accessibility tests', () => {
// generate 2 view events on an Item's page
- cy.generateViewEvent(TEST_ENTITY_PUBLICATION, 'item');
- cy.generateViewEvent(TEST_ENTITY_PUBLICATION, 'item');
+ cy.generateViewEvent(Cypress.env('DSPACE_TEST_ENTITY_PUBLICATION'), 'item');
+ cy.generateViewEvent(Cypress.env('DSPACE_TEST_ENTITY_PUBLICATION'), 'item');
cy.visit('/statistics');
diff --git a/cypress/e2e/item-edit.cy.ts b/cypress/e2e/item-edit.cy.ts
new file mode 100644
index 0000000000..ad5d8ea093
--- /dev/null
+++ b/cypress/e2e/item-edit.cy.ts
@@ -0,0 +1,180 @@
+import { testA11y } from 'cypress/support/utils';
+import { Options } from 'cypress-axe';
+
+const ITEM_EDIT_PAGE = '/items/'.concat(Cypress.env('DSPACE_TEST_ENTITY_PUBLICATION')).concat('/edit');
+
+beforeEach(() => {
+ // All tests start with visiting the Edit Item Page
+ cy.visit(ITEM_EDIT_PAGE);
+
+ // This page is restricted, so we will be shown the login form. Fill it out & submit.
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+});
+
+describe('Edit Item > Edit Metadata tab', () => {
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="metadata"]').should('be.visible');
+ cy.get('a[data-test="metadata"]').click();
+
+ // Our selected tab should be both visible & active
+ cy.get('a[data-test="metadata"]').should('be.visible');
+ cy.get('a[data-test="metadata"]').should('have.class', 'active');
+
+ // tag must be loaded
+ cy.get('ds-edit-item-page').should('be.visible');
+
+ // wait for all the ds-dso-edit-metadata-value components to be rendered
+ cy.get('ds-dso-edit-metadata-value div[role="row"]').each(($row: HTMLDivElement) => {
+ cy.wrap($row).find('div[role="cell"]').should('be.visible');
+ });
+
+ // Analyze for accessibility issues
+ testA11y('ds-edit-item-page');
+ });
+});
+
+describe('Edit Item > Status tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="status"]').should('be.visible');
+ cy.get('a[data-test="status"]').click();
+
+ // Our selected tab should be both visible & active
+ cy.get('a[data-test="status"]').should('be.visible');
+ cy.get('a[data-test="status"]').should('have.class', 'active');
+
+ // tag must be loaded
+ cy.get('ds-item-status').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-item-status');
+ });
+});
+
+describe('Edit Item > Bitstreams tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="bitstreams"]').should('be.visible');
+ cy.get('a[data-test="bitstreams"]').click();
+
+ // Our selected tab should be both visible & active
+ cy.get('a[data-test="bitstreams"]').should('be.visible');
+ cy.get('a[data-test="bitstreams"]').should('have.class', 'active');
+
+ // tag must be loaded
+ cy.get('ds-item-bitstreams').should('be.visible');
+
+ // Table of item bitstreams must also be loaded
+ cy.get('div.item-bitstreams').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-item-bitstreams',
+ {
+ rules: {
+ // Currently Bitstreams page loads a pagination component per Bundle
+ // and they all use the same 'id="p-dad"'.
+ 'duplicate-id': { enabled: false },
+ },
+ } as Options,
+ );
+ });
+});
+
+describe('Edit Item > Curate tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="curate"]').should('be.visible');
+ cy.get('a[data-test="curate"]').click();
+
+ // Our selected tab should be both visible & active
+ cy.get('a[data-test="curate"]').should('be.visible');
+ cy.get('a[data-test="curate"]').should('have.class', 'active');
+
+ // tag must be loaded
+ cy.get('ds-item-curate').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-item-curate');
+ });
+});
+
+describe('Edit Item > Relationships tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="relationships"]').should('be.visible');
+ cy.get('a[data-test="relationships"]').click();
+
+ // Our selected tab should be both visible & active
+ cy.get('a[data-test="relationships"]').should('be.visible');
+ cy.get('a[data-test="relationships"]').should('have.class', 'active');
+
+ // tag must be loaded
+ cy.get('ds-item-relationships').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-item-relationships');
+ });
+});
+
+describe('Edit Item > Version History tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="versionhistory"]').should('be.visible');
+ cy.get('a[data-test="versionhistory"]').click();
+
+ // Our selected tab should be both visible & active
+ cy.get('a[data-test="versionhistory"]').should('be.visible');
+ cy.get('a[data-test="versionhistory"]').should('have.class', 'active');
+
+ // tag must be loaded
+ cy.get('ds-item-version-history').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-item-version-history');
+ });
+});
+
+describe('Edit Item > Access Control tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="access-control"]').should('be.visible');
+ cy.get('a[data-test="access-control"]').click();
+
+ // Our selected tab should be both visible & active
+ cy.get('a[data-test="access-control"]').should('be.visible');
+ cy.get('a[data-test="access-control"]').should('have.class', 'active');
+
+ // tag must be loaded
+ cy.get('ds-item-access-control').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-item-access-control');
+ });
+});
+
+describe('Edit Item > Collection Mapper tab', () => {
+
+ it('should pass accessibility tests', () => {
+ cy.get('a[data-test="mapper"]').should('be.visible');
+ cy.get('a[data-test="mapper"]').click();
+
+ // Our selected tab should be both visible & active
+ cy.get('a[data-test="mapper"]').should('be.visible');
+ cy.get('a[data-test="mapper"]').should('have.class', 'active');
+
+ // tag must be loaded
+ cy.get('ds-item-collection-mapper').should('be.visible');
+
+ // Analyze entire page for accessibility issues
+ testA11y('ds-item-collection-mapper');
+
+ // Click on the "Map new collections" tab
+ cy.get('li[data-test="mapTab"] a').click();
+
+ // Make sure search form is now visible
+ cy.get('ds-search-form').should('be.visible');
+
+ // Analyze entire page (again) for accessibility issues
+ testA11y('ds-item-collection-mapper');
+ });
+});
diff --git a/cypress/e2e/item-page.cy.ts b/cypress/e2e/item-page.cy.ts
index 9eed711776..7d42126b82 100644
--- a/cypress/e2e/item-page.cy.ts
+++ b/cypress/e2e/item-page.cy.ts
@@ -1,31 +1,45 @@
-import { Options } from 'cypress-axe';
-import { TEST_ENTITY_PUBLICATION } from 'cypress/support/e2e';
import { testA11y } from 'cypress/support/utils';
describe('Item Page', () => {
- const ITEMPAGE = '/items/'.concat(TEST_ENTITY_PUBLICATION);
- const ENTITYPAGE = '/entities/publication/'.concat(TEST_ENTITY_PUBLICATION);
+ const ITEMPAGE = '/items/'.concat(Cypress.env('DSPACE_TEST_ENTITY_PUBLICATION'));
+ const ENTITYPAGE = '/entities/publication/'.concat(Cypress.env('DSPACE_TEST_ENTITY_PUBLICATION'));
// Test that entities will redirect to /entities/[type]/[uuid] when accessed via /items/[uuid]
it('should redirect to the entity page when navigating to an item page', () => {
cy.visit(ITEMPAGE);
+ cy.wait(1000);
cy.location('pathname').should('eq', ENTITYPAGE);
});
it('should pass accessibility tests', () => {
+ cy.intercept('POST', '/server/api/statistics/viewevents').as('viewevent');
+
cy.visit(ENTITYPAGE);
+ // Wait for the "viewevent" to trigger on the Item page.
+ // This ensures our tag is fully loaded, as the tag is contained within it.
+ cy.wait('@viewevent');
+
// tag must be loaded
cy.get('ds-item-page').should('be.visible');
// Analyze for accessibility issues
- // Disable heading-order checks until it is fixed
- testA11y('ds-item-page',
- {
- rules: {
- 'heading-order': { enabled: false }
- }
- } as Options
- );
+ testA11y('ds-item-page');
+ });
+
+ it('should pass accessibility tests on full item page', () => {
+ cy.intercept('POST', '/server/api/statistics/viewevents').as('viewevent');
+
+ cy.visit(ENTITYPAGE + '/full');
+
+ // Wait for the "viewevent" to trigger on the Item page.
+ // This ensures our tag is fully loaded, as the tag is contained within it.
+ cy.wait('@viewevent');
+
+ // tag must be loaded
+ cy.get('ds-full-item-page').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-full-item-page');
});
});
diff --git a/cypress/e2e/item-statistics.cy.ts b/cypress/e2e/item-statistics.cy.ts
index 9b90cb24af..3fdc2e7f9d 100644
--- a/cypress/e2e/item-statistics.cy.ts
+++ b/cypress/e2e/item-statistics.cy.ts
@@ -1,12 +1,12 @@
-import { REGEX_MATCH_NON_EMPTY_TEXT, TEST_ENTITY_PUBLICATION } from 'cypress/support/e2e';
+import { REGEX_MATCH_NON_EMPTY_TEXT } from 'cypress/support/e2e';
import { testA11y } from 'cypress/support/utils';
describe('Item Statistics Page', () => {
- const ITEMSTATISTICSPAGE = '/statistics/items/'.concat(TEST_ENTITY_PUBLICATION);
+ const ITEMSTATISTICSPAGE = '/statistics/items/'.concat(Cypress.env('DSPACE_TEST_ENTITY_PUBLICATION'));
it('should load if you click on "Statistics" from an Item/Entity page', () => {
- cy.visit('/entities/publication/'.concat(TEST_ENTITY_PUBLICATION));
- cy.get('ds-navbar ds-link-menu-item a[title="Statistics"]').click();
+ cy.visit('/entities/publication/'.concat(Cypress.env('DSPACE_TEST_ENTITY_PUBLICATION')));
+ cy.get('a[data-test="link-menu-item.menu.section.statistics"]').click();
cy.location('pathname').should('eq', ITEMSTATISTICSPAGE);
});
@@ -23,8 +23,7 @@ describe('Item Statistics Page', () => {
it('should contain a "Total visits per month" section', () => {
cy.visit(ITEMSTATISTICSPAGE);
- // Check just for existence because this table is empty in CI environment as it's historical data
- cy.get('.'.concat(TEST_ENTITY_PUBLICATION).concat('_TotalVisitsPerMonth')).should('exist');
+ cy.get('table[data-test="TotalVisitsPerMonth"]').should('be.visible');
});
it('should pass accessibility tests', () => {
diff --git a/cypress/e2e/login-modal.cy.ts b/cypress/e2e/login-modal.cy.ts
index b169634cfa..88c69d6dec 100644
--- a/cypress/e2e/login-modal.cy.ts
+++ b/cypress/e2e/login-modal.cy.ts
@@ -1,42 +1,42 @@
-import { TEST_ADMIN_PASSWORD, TEST_ADMIN_USER, TEST_ENTITY_PUBLICATION } from 'cypress/support/e2e';
+import { testA11y } from 'cypress/support/utils';
const page = {
- openLoginMenu() {
- // Click the "Log In" dropdown menu in header
- cy.get('ds-themed-navbar [data-test="login-menu"]').click();
- },
- openUserMenu() {
- // Once logged in, click the User menu in header
- cy.get('ds-themed-navbar [data-test="user-menu"]').click();
- },
- submitLoginAndPasswordByPressingButton(email, password) {
- // Enter email
- cy.get('ds-themed-navbar [data-test="email"]').type(email);
- // Enter password
- cy.get('ds-themed-navbar [data-test="password"]').type(password);
- // Click login button
- cy.get('ds-themed-navbar [data-test="login-button"]').click();
- },
- submitLoginAndPasswordByPressingEnter(email, password) {
- // In opened Login modal, fill out email & password, then click Enter
- cy.get('ds-themed-navbar [data-test="email"]').type(email);
- cy.get('ds-themed-navbar [data-test="password"]').type(password);
- cy.get('ds-themed-navbar [data-test="password"]').type('{enter}');
- },
- submitLogoutByPressingButton() {
- // This is the POST command that will actually log us out
- cy.intercept('POST', '/server/api/authn/logout').as('logout');
- // Click logout button
- cy.get('ds-themed-navbar [data-test="logout-button"]').click();
- // Wait until above POST command responds before continuing
- // (This ensures next action waits until logout completes)
- cy.wait('@logout');
- }
+ openLoginMenu() {
+ // Click the "Log In" dropdown menu in header
+ cy.get('[data-test="login-menu"]').click();
+ },
+ openUserMenu() {
+ // Once logged in, click the User menu in header
+ cy.get('[data-test="user-menu"]').click();
+ },
+ submitLoginAndPasswordByPressingButton(email, password) {
+ // Enter email
+ cy.get('[data-test="email"]').type(email);
+ // Enter password
+ cy.get('[data-test="password"]').type(password);
+ // Click login button
+ cy.get('[data-test="login-button"]').click();
+ },
+ submitLoginAndPasswordByPressingEnter(email, password) {
+ // In opened Login modal, fill out email & password, then click Enter
+ cy.get('[data-test="email"]').type(email);
+ cy.get('[data-test="password"]').type(password);
+ cy.get('[data-test="password"]').type('{enter}');
+ },
+ submitLogoutByPressingButton() {
+ // This is the POST command that will actually log us out
+ cy.intercept('POST', '/server/api/authn/logout').as('logout');
+ // Click logout button
+ cy.get('[data-test="logout-button"]').click();
+ // Wait until above POST command responds before continuing
+ // (This ensures next action waits until logout completes)
+ cy.wait('@logout');
+ },
};
describe('Login Modal', () => {
it('should login when clicking button & stay on same page', () => {
- const ENTITYPAGE = '/entities/publication/'.concat(TEST_ENTITY_PUBLICATION);
+ const ENTITYPAGE = '/entities/publication/'.concat(Cypress.env('DSPACE_TEST_ENTITY_PUBLICATION'));
cy.visit(ENTITYPAGE);
// Login menu should exist
@@ -46,7 +46,7 @@ describe('Login Modal', () => {
page.openLoginMenu();
cy.get('.form-login').should('be.visible');
- page.submitLoginAndPasswordByPressingButton(TEST_ADMIN_USER, TEST_ADMIN_PASSWORD);
+ page.submitLoginAndPasswordByPressingButton(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
cy.get('ds-log-in').should('not.exist');
// Verify we are still on the same page
@@ -66,8 +66,8 @@ describe('Login Modal', () => {
cy.get('.form-login').should('be.visible');
// Login, and the tag should no longer exist
- page.submitLoginAndPasswordByPressingEnter(TEST_ADMIN_USER, TEST_ADMIN_PASSWORD);
- cy.get('.form-login').should('not.exist');
+ page.submitLoginAndPasswordByPressingEnter(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ cy.get('ds-log-in').should('not.exist');
// Verify we are still on homepage
cy.url().should('include', '/home');
@@ -80,7 +80,7 @@ describe('Login Modal', () => {
it('should support logout', () => {
// First authenticate & access homepage
- cy.login(TEST_ADMIN_USER, TEST_ADMIN_PASSWORD);
+ cy.login(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
cy.visit('/');
// Verify ds-log-in tag doesn't exist, but ds-log-out tag does exist
@@ -102,12 +102,15 @@ describe('Login Modal', () => {
page.openLoginMenu();
// Registration link should be visible
- cy.get('ds-themed-navbar [data-test="register"]').should('be.visible');
+ cy.get('ds-themed-header [data-test="register"]').should('be.visible');
// Click registration link & you should go to registration page
- cy.get('ds-themed-navbar [data-test="register"]').click();
+ cy.get('ds-themed-header [data-test="register"]').click();
cy.location('pathname').should('eq', '/register');
cy.get('ds-register-email').should('exist');
+
+ // Test accessibility of this page
+ testA11y('ds-register-email');
});
it('should allow forgot password', () => {
@@ -116,11 +119,32 @@ describe('Login Modal', () => {
page.openLoginMenu();
// Forgot password link should be visible
- cy.get('ds-themed-navbar [data-test="forgot"]').should('be.visible');
+ cy.get('ds-themed-header [data-test="forgot"]').should('be.visible');
// Click link & you should go to Forgot Password page
- cy.get('ds-themed-navbar [data-test="forgot"]').click();
+ cy.get('ds-themed-header [data-test="forgot"]').click();
cy.location('pathname').should('eq', '/forgot');
cy.get('ds-forgot-email').should('exist');
+
+ // Test accessibility of this page
+ testA11y('ds-forgot-email');
+ });
+
+ it('should pass accessibility tests in menus', () => {
+ cy.visit('/');
+
+ // Open login menu & verify accessibility
+ page.openLoginMenu();
+ cy.get('ds-log-in').should('exist');
+ testA11y('ds-log-in');
+
+ // Now login
+ page.submitLoginAndPasswordByPressingButton(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ cy.get('ds-log-in').should('not.exist');
+
+ // Open user menu, verify user menu accesibility
+ page.openUserMenu();
+ cy.get('ds-user-menu').should('be.visible');
+ testA11y('ds-user-menu');
});
});
diff --git a/cypress/e2e/metadata-import-page.cy.ts b/cypress/e2e/metadata-import-page.cy.ts
new file mode 100644
index 0000000000..a31c18e4eb
--- /dev/null
+++ b/cypress/e2e/metadata-import-page.cy.ts
@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Metadata Import Page', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/admin/metadata-import');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Metadata import form must first be visible
+ cy.get('ds-metadata-import-page').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-metadata-import-page');
+ });
+});
diff --git a/cypress/e2e/metadata-registry.cy.ts b/cypress/e2e/metadata-registry.cy.ts
new file mode 100644
index 0000000000..0402d33153
--- /dev/null
+++ b/cypress/e2e/metadata-registry.cy.ts
@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Metadata Registry', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/admin/registries/metadata');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Page must first be visible
+ cy.get('ds-metadata-registry').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-metadata-registry');
+ });
+});
diff --git a/cypress/e2e/metadata-schema.cy.ts b/cypress/e2e/metadata-schema.cy.ts
new file mode 100644
index 0000000000..9ff0db0714
--- /dev/null
+++ b/cypress/e2e/metadata-schema.cy.ts
@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Metadata Schema', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/admin/registries/metadata/dc');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Page must first be visible
+ cy.get('ds-metadata-schema').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-metadata-schema');
+ });
+});
diff --git a/cypress/e2e/my-dspace.cy.ts b/cypress/e2e/my-dspace.cy.ts
index 79786c298a..c48656ffcc 100644
--- a/cypress/e2e/my-dspace.cy.ts
+++ b/cypress/e2e/my-dspace.cy.ts
@@ -1,5 +1,3 @@
-import { Options } from 'cypress-axe';
-import { TEST_SUBMIT_USER, TEST_SUBMIT_USER_PASSWORD, TEST_SUBMIT_COLLECTION_NAME } from 'cypress/support/e2e';
import { testA11y } from 'cypress/support/utils';
describe('My DSpace page', () => {
@@ -7,7 +5,7 @@ describe('My DSpace page', () => {
cy.visit('/mydspace');
// This page is restricted, so we will be shown the login form. Fill it out & submit.
- cy.loginViaForm(TEST_SUBMIT_USER, TEST_SUBMIT_USER_PASSWORD);
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_SUBMIT_USER'), Cypress.env('DSPACE_TEST_SUBMIT_USER_PASSWORD'));
cy.get('ds-my-dspace-page').should('be.visible');
@@ -19,28 +17,14 @@ describe('My DSpace page', () => {
cy.get('.filter-toggle').click({ multiple: true });
// Analyze for accessibility issues
- testA11y(
- {
- include: ['ds-my-dspace-page'],
- exclude: [
- ['nouislider'] // Date filter slider is missing ARIA labels. Will be fixed by #1175
- ],
- },
- {
- rules: {
- // Search filters fail these two "moderate" impact rules
- 'heading-order': { enabled: false },
- 'landmark-unique': { enabled: false }
- }
- } as Options
- );
+ testA11y('ds-my-dspace-page');
});
it('should have a working detailed view that passes accessibility tests', () => {
cy.visit('/mydspace');
// This page is restricted, so we will be shown the login form. Fill it out & submit.
- cy.loginViaForm(TEST_SUBMIT_USER, TEST_SUBMIT_USER_PASSWORD);
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_SUBMIT_USER'), Cypress.env('DSPACE_TEST_SUBMIT_USER_PASSWORD'));
cy.get('ds-my-dspace-page').should('be.visible');
@@ -49,16 +33,8 @@ describe('My DSpace page', () => {
cy.get('ds-object-detail').should('be.visible');
- // Analyze for accessibility issues
- testA11y('ds-my-dspace-page',
- {
- rules: {
- // Search filters fail these two "moderate" impact rules
- 'heading-order': { enabled: false },
- 'landmark-unique': { enabled: false }
- }
- } as Options
- );
+ // Analyze for accessibility issues
+ testA11y('ds-my-dspace-page');
});
// NOTE: Deleting existing submissions is exercised by submission.spec.ts
@@ -66,7 +42,7 @@ describe('My DSpace page', () => {
cy.visit('/mydspace');
// This page is restricted, so we will be shown the login form. Fill it out & submit.
- cy.loginViaForm(TEST_SUBMIT_USER, TEST_SUBMIT_USER_PASSWORD);
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_SUBMIT_USER'), Cypress.env('DSPACE_TEST_SUBMIT_USER_PASSWORD'));
// Open the New Submission dropdown
cy.get('button[data-test="submission-dropdown"]').click();
@@ -77,10 +53,10 @@ describe('My DSpace page', () => {
cy.get('ds-create-item-parent-selector').should('be.visible');
// Type in a known Collection name in the search box
- cy.get('ds-authorized-collection-selector input[type="search"]').type(TEST_SUBMIT_COLLECTION_NAME);
+ cy.get('ds-authorized-collection-selector input[type="search"]').type(Cypress.env('DSPACE_TEST_SUBMIT_COLLECTION_NAME'));
// Click on the button matching that known Collection name
- cy.get('ds-authorized-collection-selector button[title="'.concat(TEST_SUBMIT_COLLECTION_NAME).concat('"]')).click();
+ cy.get('ds-authorized-collection-selector button[title="'.concat(Cypress.env('DSPACE_TEST_SUBMIT_COLLECTION_NAME')).concat('"]')).click();
// New URL should include /workspaceitems, as we've started a new submission
cy.url().should('include', '/workspaceitems');
@@ -89,7 +65,7 @@ describe('My DSpace page', () => {
cy.get('ds-submission-edit').should('be.visible');
// A Collection menu button should exist & its value should be the selected collection
- cy.get('#collectionControlsMenuButton span').should('have.text', TEST_SUBMIT_COLLECTION_NAME);
+ cy.get('#collectionControlsMenuButton span').should('have.text', Cypress.env('DSPACE_TEST_SUBMIT_COLLECTION_NAME'));
// Now that we've created a submission, we'll test that we can go back and Edit it.
// Get our Submission URL, to parse out the ID of this new submission
@@ -138,7 +114,7 @@ describe('My DSpace page', () => {
cy.visit('/mydspace');
// This page is restricted, so we will be shown the login form. Fill it out & submit.
- cy.loginViaForm(TEST_SUBMIT_USER, TEST_SUBMIT_USER_PASSWORD);
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_SUBMIT_USER'), Cypress.env('DSPACE_TEST_SUBMIT_USER_PASSWORD'));
// Open the New Import dropdown
cy.get('button[data-test="import-dropdown"]').click();
@@ -150,6 +126,9 @@ describe('My DSpace page', () => {
// The external import searchbox should be visible
cy.get('ds-submission-import-external-searchbar').should('be.visible');
+
+ // Test for accessibility issues
+ testA11y('ds-submission-import-external');
});
});
diff --git a/cypress/e2e/new-process.cy.ts b/cypress/e2e/new-process.cy.ts
new file mode 100644
index 0000000000..d26da7cc4d
--- /dev/null
+++ b/cypress/e2e/new-process.cy.ts
@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('New Process', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/processes/new');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Process form must first be visible
+ cy.get('ds-new-process').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-new-process');
+ });
+});
diff --git a/cypress/e2e/pagenotfound.cy.ts b/cypress/e2e/pagenotfound.cy.ts
index 43e3c3af24..d02aa8541c 100644
--- a/cypress/e2e/pagenotfound.cy.ts
+++ b/cypress/e2e/pagenotfound.cy.ts
@@ -1,8 +1,13 @@
+import { testA11y } from 'cypress/support/utils';
+
describe('PageNotFound', () => {
it('should contain element ds-pagenotfound when navigating to page that doesnt exist', () => {
// request an invalid page (UUIDs at root path aren't valid)
cy.visit('/e9019a69-d4f1-4773-b6a3-bd362caa46f2', { failOnStatusCode: false });
cy.get('ds-pagenotfound').should('be.visible');
+
+ // Analyze for accessibility issues
+ testA11y('ds-pagenotfound');
});
it('should not contain element ds-pagenotfound when navigating to existing page', () => {
diff --git a/cypress/e2e/privacy.cy.ts b/cypress/e2e/privacy.cy.ts
new file mode 100644
index 0000000000..16e049f701
--- /dev/null
+++ b/cypress/e2e/privacy.cy.ts
@@ -0,0 +1,13 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Privacy', () => {
+ it('should pass accessibility tests', () => {
+ cy.visit('/info/privacy');
+
+ // Page must first be visible
+ cy.get('ds-privacy').should('be.visible');
+
+ // Analyze for accessibility
+ testA11y('ds-privacy');
+ });
+});
diff --git a/cypress/e2e/processes-overview.cy.ts b/cypress/e2e/processes-overview.cy.ts
new file mode 100644
index 0000000000..2be3bd4c18
--- /dev/null
+++ b/cypress/e2e/processes-overview.cy.ts
@@ -0,0 +1,17 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Processes Overview', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/processes');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+
+ // Process overview must first be visible
+ cy.get('ds-process-overview').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-process-overview');
+ });
+});
diff --git a/cypress/e2e/profile-page.cy.ts b/cypress/e2e/profile-page.cy.ts
new file mode 100644
index 0000000000..911ef33ba5
--- /dev/null
+++ b/cypress/e2e/profile-page.cy.ts
@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Profile page', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/profile');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Process form must first be visible
+ cy.get('ds-profile-page').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-profile-page');
+ });
+});
diff --git a/cypress/e2e/search-navbar.cy.ts b/cypress/e2e/search-navbar.cy.ts
index 648db17fe6..28a72bcc78 100644
--- a/cypress/e2e/search-navbar.cy.ts
+++ b/cypress/e2e/search-navbar.cy.ts
@@ -1,23 +1,21 @@
-import { TEST_SEARCH_TERM } from 'cypress/support/e2e';
-
const page = {
fillOutQueryInNavBar(query) {
// Click the magnifying glass
- cy.get('ds-themed-navbar [data-test="header-search-icon"]').click();
+ cy.get('ds-themed-header [data-test="header-search-icon"]').click();
// Fill out a query in input that appears
- cy.get('ds-themed-navbar [data-test="header-search-box"]').type(query);
+ cy.get('ds-themed-header [data-test="header-search-box"]').type(query);
},
submitQueryByPressingEnter() {
- cy.get('ds-themed-navbar [data-test="header-search-box"]').type('{enter}');
+ cy.get('ds-themed-header [data-test="header-search-box"]').type('{enter}');
},
submitQueryByPressingIcon() {
- cy.get('ds-themed-navbar [data-test="header-search-icon"]').click();
+ cy.get('ds-themed-header [data-test="header-search-icon"]').click();
}
};
describe('Search from Navigation Bar', () => {
// NOTE: these tests currently assume this query will return results!
- const query = TEST_SEARCH_TERM;
+ const query = Cypress.env('DSPACE_TEST_SEARCH_TERM');
it('should go to search page with correct query if submitted (from home)', () => {
cy.visit('/');
diff --git a/cypress/e2e/search-page.cy.ts b/cypress/e2e/search-page.cy.ts
index 24519cc236..429f4e6da4 100644
--- a/cypress/e2e/search-page.cy.ts
+++ b/cypress/e2e/search-page.cy.ts
@@ -1,8 +1,10 @@
import { Options } from 'cypress-axe';
-import { TEST_SEARCH_TERM } from 'cypress/support/e2e';
import { testA11y } from 'cypress/support/utils';
describe('Search Page', () => {
+ // NOTE: these tests currently assume this query will return results!
+ const query = Cypress.env('DSPACE_TEST_SEARCH_TERM');
+
it('should redirect to the correct url when query was set and submit button was triggered', () => {
const queryString = 'Another interesting query string';
cy.visit('/search');
@@ -13,8 +15,8 @@ describe('Search Page', () => {
});
it('should load results and pass accessibility tests', () => {
- cy.visit('/search?query='.concat(TEST_SEARCH_TERM));
- cy.get('[data-test="search-box"]').should('have.value', TEST_SEARCH_TERM);
+ cy.visit('/search?query='.concat(query));
+ cy.get('[data-test="search-box"]').should('have.value', query);
// tag must be loaded
cy.get('ds-search-page').should('be.visible');
@@ -27,25 +29,11 @@ describe('Search Page', () => {
cy.get('[data-test="filter-toggle"]').click({ multiple: true });
// Analyze for accessibility issues
- testA11y(
- {
- include: ['ds-search-page'],
- exclude: [
- ['nouislider'] // Date filter slider is missing ARIA labels. Will be fixed by #1175
- ],
- },
- {
- rules: {
- // Search filters fail these two "moderate" impact rules
- 'heading-order': { enabled: false },
- 'landmark-unique': { enabled: false }
- }
- } as Options
- );
+ testA11y('ds-search-page');
});
it('should have a working grid view that passes accessibility tests', () => {
- cy.visit('/search?query='.concat(TEST_SEARCH_TERM));
+ cy.visit('/search?query='.concat(query));
// Click button in sidebar to display grid view
cy.get('ds-search-sidebar [data-test="grid-view"]').click();
@@ -60,9 +48,8 @@ describe('Search Page', () => {
testA11y('ds-search-page',
{
rules: {
- // Search filters fail these two "moderate" impact rules
- 'heading-order': { enabled: false },
- 'landmark-unique': { enabled: false }
+ // Card titles fail this test currently
+ 'heading-order': { enabled: false }
}
} as Options
);
diff --git a/cypress/e2e/submission.cy.ts b/cypress/e2e/submission.cy.ts
index ed10b2d13a..8215b4749d 100644
--- a/cypress/e2e/submission.cy.ts
+++ b/cypress/e2e/submission.cy.ts
@@ -1,14 +1,16 @@
-import { TEST_SUBMIT_USER, TEST_SUBMIT_USER_PASSWORD, TEST_SUBMIT_COLLECTION_NAME, TEST_SUBMIT_COLLECTION_UUID } from 'cypress/support/e2e';
+import { testA11y } from 'cypress/support/utils';
+//import { TEST_SUBMIT_USER, TEST_SUBMIT_USER_PASSWORD, TEST_SUBMIT_COLLECTION_NAME, TEST_SUBMIT_COLLECTION_UUID, TEST_ADMIN_USER, TEST_ADMIN_PASSWORD } from 'cypress/support/e2e';
+import { Options } from 'cypress-axe';
describe('New Submission page', () => {
- // NOTE: We already test that new submissions can be started from MyDSpace in my-dspace.spec.ts
+ // NOTE: We already test that new Item submissions can be started from MyDSpace in my-dspace.spec.ts
it('should create a new submission when using /submit path & pass accessibility', () => {
// Test that calling /submit with collection & entityType will create a new submission
- cy.visit('/submit?collection='.concat(TEST_SUBMIT_COLLECTION_UUID).concat('&entityType=none'));
+ cy.visit('/submit?collection='.concat(Cypress.env('DSPACE_TEST_SUBMIT_COLLECTION_UUID')).concat('&entityType=none'));
// This page is restricted, so we will be shown the login form. Fill it out & submit.
- cy.loginViaForm(TEST_SUBMIT_USER, TEST_SUBMIT_USER_PASSWORD);
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_SUBMIT_USER'), Cypress.env('DSPACE_TEST_SUBMIT_USER_PASSWORD'));
// Should redirect to /workspaceitems, as we've started a new submission
cy.url().should('include', '/workspaceitems');
@@ -17,7 +19,7 @@ describe('New Submission page', () => {
cy.get('ds-submission-edit').should('be.visible');
// A Collection menu button should exist & it's value should be the selected collection
- cy.get('#collectionControlsMenuButton span').should('have.text', TEST_SUBMIT_COLLECTION_NAME);
+ cy.get('#collectionControlsMenuButton span').should('have.text', Cypress.env('DSPACE_TEST_SUBMIT_COLLECTION_NAME'));
// 4 sections should be visible by default
cy.get('div#section_traditionalpageone').should('be.visible');
@@ -25,6 +27,25 @@ describe('New Submission page', () => {
cy.get('div#section_upload').should('be.visible');
cy.get('div#section_license').should('be.visible');
+ // Test entire page for accessibility
+ testA11y('ds-submission-edit',
+ {
+ rules: {
+ // Author & Subject fields have invalid "aria-multiline" attrs.
+ // See https://github.com/DSpace/dspace-angular/issues/1272
+ 'aria-allowed-attr': { enabled: false },
+ // All panels are accordians & fail "aria-required-children" and "nested-interactive".
+ // Seem to require updating ng-bootstrap and https://github.com/DSpace/dspace-angular/issues/2216
+ 'aria-required-children': { enabled: false },
+ 'nested-interactive': { enabled: false },
+ // All select boxes fail to have a name / aria-label.
+ // This is a bug in ng-dynamic-forms and may require https://github.com/DSpace/dspace-angular/issues/2216
+ 'select-name': { enabled: false },
+ }
+
+ } as Options
+ );
+
// Discard button should work
// Clicking it will display a confirmation, which we will confirm with another click
cy.get('button#discard').click();
@@ -33,10 +54,10 @@ describe('New Submission page', () => {
it('should block submission & show errors if required fields are missing', () => {
// Create a new submission
- cy.visit('/submit?collection='.concat(TEST_SUBMIT_COLLECTION_UUID).concat('&entityType=none'));
+ cy.visit('/submit?collection='.concat(Cypress.env('DSPACE_TEST_SUBMIT_COLLECTION_UUID')).concat('&entityType=none'));
// This page is restricted, so we will be shown the login form. Fill it out & submit.
- cy.loginViaForm(TEST_SUBMIT_USER, TEST_SUBMIT_USER_PASSWORD);
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_SUBMIT_USER'), Cypress.env('DSPACE_TEST_SUBMIT_USER_PASSWORD'));
// Attempt an immediate deposit without filling out any fields
cy.get('button#deposit').click();
@@ -93,10 +114,10 @@ describe('New Submission page', () => {
it('should allow for deposit if all required fields completed & file uploaded', () => {
// Create a new submission
- cy.visit('/submit?collection='.concat(TEST_SUBMIT_COLLECTION_UUID).concat('&entityType=none'));
+ cy.visit('/submit?collection='.concat(Cypress.env('DSPACE_TEST_SUBMIT_COLLECTION_UUID')).concat('&entityType=none'));
// This page is restricted, so we will be shown the login form. Fill it out & submit.
- cy.loginViaForm(TEST_SUBMIT_USER, TEST_SUBMIT_USER_PASSWORD);
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_SUBMIT_USER'), Cypress.env('DSPACE_TEST_SUBMIT_USER_PASSWORD'));
// Fill out all required fields (Title, Date)
cy.get('input#dc_title').type('DSpace logo uploaded via e2e tests');
@@ -116,7 +137,7 @@ describe('New Submission page', () => {
// Upload our DSpace logo via drag & drop onto submission form
// cy.get('div#section_upload')
- cy.get('div.ds-document-drop-zone').selectFile('src/assets/images/dspace-logo.png', {
+ cy.get('div.ds-document-drop-zone').selectFile('src/assets/images/dspace-logo.svg', {
action: 'drag-drop'
});
@@ -131,4 +152,76 @@ describe('New Submission page', () => {
cy.get('ds-notification div.alert-success').should('be.visible');
});
+ it('is possible to submit a new "Person" and that form passes accessibility', () => {
+ // To submit a different entity type, we'll start from MyDSpace
+ cy.visit('/mydspace');
+
+ // This page is restricted, so we will be shown the login form. Fill it out & submit.
+ // NOTE: At this time, we MUST login as admin to submit Person objects
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+
+ // Open the New Submission dropdown
+ cy.get('button[data-test="submission-dropdown"]').click();
+ // Click on the "Person" type in that dropdown
+ cy.get('#entityControlsDropdownMenu button[title="Person"]').click();
+
+ // This should display the (popup window)
+ cy.get('ds-create-item-parent-selector').should('be.visible');
+
+ // Type in a known Collection name in the search box
+ cy.get('ds-authorized-collection-selector input[type="search"]').type(Cypress.env('DSPACE_TEST_SUBMIT_PERSON_COLLECTION_NAME'));
+
+ // Click on the button matching that known Collection name
+ cy.get('ds-authorized-collection-selector button[title="'.concat(Cypress.env('DSPACE_TEST_SUBMIT_PERSON_COLLECTION_NAME')).concat('"]')).click();
+
+ // New URL should include /workspaceitems, as we've started a new submission
+ cy.url().should('include', '/workspaceitems');
+
+ // The Submission edit form tag should be visible
+ cy.get('ds-submission-edit').should('be.visible');
+
+ // A Collection menu button should exist & its value should be the selected collection
+ cy.get('#collectionControlsMenuButton span').should('have.text', Cypress.env('DSPACE_TEST_SUBMIT_PERSON_COLLECTION_NAME'));
+
+ // 3 sections should be visible by default
+ cy.get('div#section_personStep').should('be.visible');
+ cy.get('div#section_upload').should('be.visible');
+ cy.get('div#section_license').should('be.visible');
+
+ // Test entire page for accessibility
+ testA11y('ds-submission-edit',
+ {
+ rules: {
+ // All panels are accordians & fail "aria-required-children" and "nested-interactive".
+ // Seem to require updating ng-bootstrap and https://github.com/DSpace/dspace-angular/issues/2216
+ 'aria-required-children': { enabled: false },
+ 'nested-interactive': { enabled: false },
+ }
+
+ } as Options
+ );
+
+ // Click the lookup button next to "Publication" field
+ cy.get('button[data-test="lookup-button"]').click();
+
+ // A popup modal window should be visible
+ cy.get('ds-dynamic-lookup-relation-modal').should('be.visible');
+
+ // Popup modal should also pass accessibility tests
+ //testA11y('ds-dynamic-lookup-relation-modal');
+ testA11y({
+ include: ['ds-dynamic-lookup-relation-modal'],
+ exclude: [
+ ['ul.nav-tabs'] // Tabs at top of model have several issues which seem to be caused by ng-bootstrap
+ ],
+ });
+
+ // Close popup window
+ cy.get('ds-dynamic-lookup-relation-modal button.close').click();
+
+ // Back on the form, click the discard button to remove new submission
+ // Clicking it will display a confirmation, which we will confirm with another click
+ cy.get('button#discard').click();
+ cy.get('button#discard_submit').click();
+ });
});
diff --git a/cypress/e2e/system-wide-alert.cy.ts b/cypress/e2e/system-wide-alert.cy.ts
new file mode 100644
index 0000000000..046bfe619f
--- /dev/null
+++ b/cypress/e2e/system-wide-alert.cy.ts
@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('System Wide Alert', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/admin/system-wide-alert');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Page must first be visible
+ cy.get('ds-system-wide-alert-form').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-system-wide-alert-form');
+ });
+});
diff --git a/cypress/plugins/index.ts b/cypress/plugins/index.ts
index ead38afb92..cc3dccba38 100644
--- a/cypress/plugins/index.ts
+++ b/cypress/plugins/index.ts
@@ -1,5 +1,11 @@
const fs = require('fs');
+// These two global variables are used to store information about the REST API used
+// by these e2e tests. They are filled out prior to running any tests in the before()
+// method of e2e.ts. They can then be accessed by any tests via the getters below.
+let REST_BASE_URL: string;
+let REST_DOMAIN: string;
+
// Plugins enable you to tap into, modify, or extend the internal behavior of Cypress
// For more info, visit https://on.cypress.io/plugins-api
module.exports = (on, config) => {
@@ -30,6 +36,24 @@ module.exports = (on, config) => {
}
return null;
+ },
+ // Save value of REST Base URL, looked up before all tests.
+ // This allows other tests to use it easily via getRestBaseURL() below.
+ saveRestBaseURL(url: string) {
+ return (REST_BASE_URL = url);
+ },
+ // Retrieve currently saved value of REST Base URL
+ getRestBaseURL() {
+ return REST_BASE_URL ;
+ },
+ // Save value of REST Domain, looked up before all tests.
+ // This allows other tests to use it easily via getRestBaseDomain() below.
+ saveRestBaseDomain(domain: string) {
+ return (REST_DOMAIN = domain);
+ },
+ // Retrieve currently saved value of REST Domain
+ getRestBaseDomain() {
+ return REST_DOMAIN ;
}
});
};
diff --git a/cypress/support/commands.ts b/cypress/support/commands.ts
index c70c4e37e1..d433424d6f 100644
--- a/cypress/support/commands.ts
+++ b/cypress/support/commands.ts
@@ -5,11 +5,7 @@
import { AuthTokenInfo, TOKENITEM } from 'src/app/core/auth/models/auth-token-info.model';
import { DSPACE_XSRF_COOKIE, XSRF_REQUEST_HEADER } from 'src/app/core/xsrf/xsrf.constants';
-
-// NOTE: FALLBACK_TEST_REST_BASE_URL is only used if Cypress cannot read the REST API BaseURL
-// from the Angular UI's config.json. See 'login()'.
-export const FALLBACK_TEST_REST_BASE_URL = 'http://localhost:8080/server';
-export const FALLBACK_TEST_REST_DOMAIN = 'localhost';
+import { v4 as uuidv4 } from 'uuid';
// Declare Cypress namespace to help with Intellisense & code completion in IDEs
// ALL custom commands MUST be listed here for code completion to work
@@ -41,6 +37,13 @@ declare global {
* @param dsoType type of DSpace Object (e.g. "item", "collection", "community")
*/
generateViewEvent(uuid: string, dsoType: string): typeof generateViewEvent;
+
+ /**
+ * Create a new CSRF token and add to required Cookie. CSRF Token is returned
+ * in chainable in order to allow it to be sent also in required CSRF header.
+ * @returns Chainable reference to allow CSRF token to also be sent in header.
+ */
+ createCSRFCookie(): Chainable;
}
}
}
@@ -54,59 +57,32 @@ declare global {
* @param password password to login as
*/
function login(email: string, password: string): void {
- // Cypress doesn't have access to the running application in Node.js.
- // So, it's not possible to inject or load the AppConfig or environment of the Angular UI.
- // Instead, we'll read our running application's config.json, which contains the configs &
- // is regenerated at runtime each time the Angular UI application starts up.
- cy.task('readUIConfig').then((str: string) => {
- // Parse config into a JSON object
- const config = JSON.parse(str);
+ // Create a fake CSRF cookie/token to use in POST
+ cy.createCSRFCookie().then((csrfToken: string) => {
+ // get our REST API's base URL, also needed for POST
+ cy.task('getRestBaseURL').then((baseRestUrl: string) => {
+ // Now, send login POST request including that CSRF token
+ cy.request({
+ method: 'POST',
+ url: baseRestUrl + '/api/authn/login',
+ headers: { [XSRF_REQUEST_HEADER]: csrfToken},
+ form: true, // indicates the body should be form urlencoded
+ body: { user: email, password: password }
+ }).then((resp) => {
+ // We expect a successful login
+ expect(resp.status).to.eq(200);
+ // We expect to have a valid authorization header returned (with our auth token)
+ expect(resp.headers).to.have.property('authorization');
- // Find the URL of our REST API. Have a fallback ready, just in case 'rest.baseUrl' cannot be found.
- let baseRestUrl = FALLBACK_TEST_REST_BASE_URL;
- if (!config.rest.baseUrl) {
- console.warn("Could not load 'rest.baseUrl' from config.json. Falling back to " + FALLBACK_TEST_REST_BASE_URL);
- } else {
- //console.log("Found 'rest.baseUrl' in config.json. Using this REST API for login: ".concat(config.rest.baseUrl));
- baseRestUrl = config.rest.baseUrl;
- }
+ // Initialize our AuthTokenInfo object from the authorization header.
+ const authheader = resp.headers.authorization as string;
+ const authinfo: AuthTokenInfo = new AuthTokenInfo(authheader);
- // Now find domain of our REST API, again with a fallback.
- let baseDomain = FALLBACK_TEST_REST_DOMAIN;
- if (!config.rest.host) {
- console.warn("Could not load 'rest.host' from config.json. Falling back to " + FALLBACK_TEST_REST_DOMAIN);
- } else {
- baseDomain = config.rest.host;
- }
-
- // Create a fake CSRF Token. Set it in the required server-side cookie
- const csrfToken = 'fakeLoginCSRFToken';
- cy.setCookie(DSPACE_XSRF_COOKIE, csrfToken, { 'domain': baseDomain });
-
- // Now, send login POST request including that CSRF token
- cy.request({
- method: 'POST',
- url: baseRestUrl + '/api/authn/login',
- headers: { [XSRF_REQUEST_HEADER]: csrfToken},
- form: true, // indicates the body should be form urlencoded
- body: { user: email, password: password }
- }).then((resp) => {
- // We expect a successful login
- expect(resp.status).to.eq(200);
- // We expect to have a valid authorization header returned (with our auth token)
- expect(resp.headers).to.have.property('authorization');
-
- // Initialize our AuthTokenInfo object from the authorization header.
- const authheader = resp.headers.authorization as string;
- const authinfo: AuthTokenInfo = new AuthTokenInfo(authheader);
-
- // Save our AuthTokenInfo object to our dsAuthInfo UI cookie
- // This ensures the UI will recognize we are logged in on next "visit()"
- cy.setCookie(TOKENITEM, JSON.stringify(authinfo));
+ // Save our AuthTokenInfo object to our dsAuthInfo UI cookie
+ // This ensures the UI will recognize we are logged in on next "visit()"
+ cy.setCookie(TOKENITEM, JSON.stringify(authinfo));
+ });
});
-
- // Remove cookie with fake CSRF token, as it's no longer needed
- cy.clearCookie(DSPACE_XSRF_COOKIE);
});
}
// Add as a Cypress command (i.e. assign to 'cy.login')
@@ -118,12 +94,12 @@ Cypress.Commands.add('login', login);
* @param password password to login as
*/
function loginViaForm(email: string, password: string): void {
- // Enter email
- cy.get('ds-log-in [data-test="email"]').type(email);
- // Enter password
- cy.get('ds-log-in [data-test="password"]').type(password);
- // Click login button
- cy.get('ds-log-in [data-test="login-button"]').click();
+ // Enter email
+ cy.get('[data-test="email"]').type(email);
+ // Enter password
+ cy.get('[data-test="password"]').type(password);
+ // Click login button
+ cy.get('[data-test="login-button"]').click();
}
// Add as a Cypress command (i.e. assign to 'cy.loginViaForm')
Cypress.Commands.add('loginViaForm', loginViaForm);
@@ -141,54 +117,53 @@ Cypress.Commands.add('loginViaForm', loginViaForm);
* @param dsoType type of DSpace Object (e.g. "item", "collection", "community")
*/
function generateViewEvent(uuid: string, dsoType: string): void {
- // Cypress doesn't have access to the running application in Node.js.
- // So, it's not possible to inject or load the AppConfig or environment of the Angular UI.
- // Instead, we'll read our running application's config.json, which contains the configs &
- // is regenerated at runtime each time the Angular UI application starts up.
- cy.task('readUIConfig').then((str: string) => {
- // Parse config into a JSON object
- const config = JSON.parse(str);
-
- // Find the URL of our REST API. Have a fallback ready, just in case 'rest.baseUrl' cannot be found.
- let baseRestUrl = FALLBACK_TEST_REST_BASE_URL;
- if (!config.rest.baseUrl) {
- console.warn("Could not load 'rest.baseUrl' from config.json. Falling back to " + FALLBACK_TEST_REST_BASE_URL);
- } else {
- baseRestUrl = config.rest.baseUrl;
- }
-
- // Now find domain of our REST API, again with a fallback.
- let baseDomain = FALLBACK_TEST_REST_DOMAIN;
- if (!config.rest.host) {
- console.warn("Could not load 'rest.host' from config.json. Falling back to " + FALLBACK_TEST_REST_DOMAIN);
- } else {
- baseDomain = config.rest.host;
- }
-
- // Create a fake CSRF Token. Set it in the required server-side cookie
- const csrfToken = 'fakeGenerateViewEventCSRFToken';
- cy.setCookie(DSPACE_XSRF_COOKIE, csrfToken, { 'domain': baseDomain });
-
- // Now, send 'statistics/viewevents' POST request including that fake CSRF token in required header
- cy.request({
- method: 'POST',
- url: baseRestUrl + '/api/statistics/viewevents',
- headers: {
- [XSRF_REQUEST_HEADER] : csrfToken,
- // use a known public IP address to avoid being seen as a "bot"
- 'X-Forwarded-For': '1.1.1.1',
- },
- //form: true, // indicates the body should be form urlencoded
- body: { targetId: uuid, targetType: dsoType },
- }).then((resp) => {
- // We expect a 201 (which means statistics event was created)
- expect(resp.status).to.eq(201);
+ // Create a fake CSRF cookie/token to use in POST
+ cy.createCSRFCookie().then((csrfToken: string) => {
+ // get our REST API's base URL, also needed for POST
+ cy.task('getRestBaseURL').then((baseRestUrl: string) => {
+ // Now, send 'statistics/viewevents' POST request including that fake CSRF token in required header
+ cy.request({
+ method: 'POST',
+ url: baseRestUrl + '/api/statistics/viewevents',
+ headers: {
+ [XSRF_REQUEST_HEADER] : csrfToken,
+ // use a known public IP address to avoid being seen as a "bot"
+ 'X-Forwarded-For': '1.1.1.1',
+ // Use a user-agent of a Firefox browser on Windows. This again avoids being seen as a "bot"
+ 'user-agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/119.0',
+ },
+ //form: true, // indicates the body should be form urlencoded
+ body: { targetId: uuid, targetType: dsoType },
+ }).then((resp) => {
+ // We expect a 201 (which means statistics event was created)
+ expect(resp.status).to.eq(201);
+ });
});
-
- // Remove cookie with fake CSRF token, as it's no longer needed
- cy.clearCookie(DSPACE_XSRF_COOKIE);
});
}
// Add as a Cypress command (i.e. assign to 'cy.generateViewEvent')
Cypress.Commands.add('generateViewEvent', generateViewEvent);
+
+/**
+ * Can be used by tests to generate a random XSRF/CSRF token and save it to
+ * the required XSRF/CSRF cookie for usage when sending POST requests or similar.
+ * The generated CSRF token is returned in a Chainable to allow it to be also sent
+ * in the CSRF HTTP Header.
+ * @returns a Cypress Chainable which can be used to get the generated CSRF Token
+ */
+function createCSRFCookie(): Cypress.Chainable {
+ // Generate a new token which is a random UUID
+ const csrfToken: string = uuidv4();
+
+ // Save it to our required cookie
+ cy.task('getRestBaseDomain').then((baseDomain: string) => {
+ // Create a fake CSRF Token. Set it in the required server-side cookie
+ cy.setCookie(DSPACE_XSRF_COOKIE, csrfToken, { 'domain': baseDomain });
+ });
+
+ // return the generated token wrapped in a chainable
+ return cy.wrap(csrfToken);
+}
+// Add as a Cypress command (i.e. assign to 'cy.createCSRFCookie')
+Cypress.Commands.add('createCSRFCookie', createCSRFCookie);
diff --git a/cypress/support/e2e.ts b/cypress/support/e2e.ts
index dd7ee1824c..f6c6865052 100644
--- a/cypress/support/e2e.ts
+++ b/cypress/support/e2e.ts
@@ -19,45 +19,54 @@ import './commands';
// Import Cypress Axe tools for all tests
// https://github.com/component-driven/cypress-axe
import 'cypress-axe';
+import { DSPACE_XSRF_COOKIE } from 'src/app/core/xsrf/xsrf.constants';
+
+
+// Runs once before all tests
+before(() => {
+ // Cypress doesn't have access to the running application in Node.js.
+ // So, it's not possible to inject or load the AppConfig or environment of the Angular UI.
+ // Instead, we'll read our running application's config.json, which contains the configs &
+ // is regenerated at runtime each time the Angular UI application starts up.
+ cy.task('readUIConfig').then((str: string) => {
+ // Parse config into a JSON object
+ const config = JSON.parse(str);
+
+ // Find URL of our REST API & save to global variable via task
+ let baseRestUrl = FALLBACK_TEST_REST_BASE_URL;
+ if (!config.rest.baseUrl) {
+ console.warn("Could not load 'rest.baseUrl' from config.json. Falling back to " + FALLBACK_TEST_REST_BASE_URL);
+ } else {
+ baseRestUrl = config.rest.baseUrl;
+ }
+ cy.task('saveRestBaseURL', baseRestUrl);
+
+ // Find domain of our REST API & save to global variable via task.
+ let baseDomain = FALLBACK_TEST_REST_DOMAIN;
+ if (!config.rest.host) {
+ console.warn("Could not load 'rest.host' from config.json. Falling back to " + FALLBACK_TEST_REST_DOMAIN);
+ } else {
+ baseDomain = config.rest.host;
+ }
+ cy.task('saveRestBaseDomain', baseDomain);
+
+ });
+});
// Runs once before the first test in each "block"
beforeEach(() => {
// Pre-agree to all Klaro cookies by setting the klaro-anonymous cookie
// This just ensures it doesn't get in the way of matching other objects in the page.
cy.setCookie('klaro-anonymous', '{%22authentication%22:true%2C%22preferences%22:true%2C%22acknowledgement%22:true%2C%22google-analytics%22:true%2C%22google-recaptcha%22:true}');
+
+ // Remove any CSRF cookies saved from prior tests
+ cy.clearCookie(DSPACE_XSRF_COOKIE);
});
-// For better stability between tests, we visit "about:blank" (i.e. blank page) after each test.
-// This ensures any remaining/outstanding XHR requests are killed, so they don't affect the next test.
-// Borrowed from: https://glebbahmutov.com/blog/visit-blank-page-between-tests/
-/*afterEach(() => {
- cy.window().then((win) => {
- win.location.href = 'about:blank';
- });
-});*/
-
-
-// Global constants used in tests
-// May be overridden in our cypress.json config file using specified environment variables.
-// Default values listed here are all valid for the Demo Entities Data set available at
-// https://github.com/DSpace-Labs/AIP-Files/releases/tag/demo-entities-data
-// (This is the data set used in our CI environment)
-
-// Admin account used for administrative tests
-export const TEST_ADMIN_USER = Cypress.env('DSPACE_TEST_ADMIN_USER') || 'dspacedemo+admin@gmail.com';
-export const TEST_ADMIN_PASSWORD = Cypress.env('DSPACE_TEST_ADMIN_PASSWORD') || 'dspace';
-// Community/collection/publication used for view/edit tests
-export const TEST_COLLECTION = Cypress.env('DSPACE_TEST_COLLECTION') || '282164f5-d325-4740-8dd1-fa4d6d3e7200';
-export const TEST_COMMUNITY = Cypress.env('DSPACE_TEST_COMMUNITY') || '0958c910-2037-42a9-81c7-dca80e3892b4';
-export const TEST_ENTITY_PUBLICATION = Cypress.env('DSPACE_TEST_ENTITY_PUBLICATION') || 'e98b0f27-5c19-49a0-960d-eb6ad5287067';
-// Search term (should return results) used in search tests
-export const TEST_SEARCH_TERM = Cypress.env('DSPACE_TEST_SEARCH_TERM') || 'test';
-// Collection used for submission tests
-export const TEST_SUBMIT_COLLECTION_NAME = Cypress.env('DSPACE_TEST_SUBMIT_COLLECTION_NAME') || 'Sample Collection';
-export const TEST_SUBMIT_COLLECTION_UUID = Cypress.env('DSPACE_TEST_SUBMIT_COLLECTION_UUID') || '9d8334e9-25d3-4a67-9cea-3dffdef80144';
-export const TEST_SUBMIT_USER = Cypress.env('DSPACE_TEST_SUBMIT_USER') || 'dspacedemo+submit@gmail.com';
-export const TEST_SUBMIT_USER_PASSWORD = Cypress.env('DSPACE_TEST_SUBMIT_USER_PASSWORD') || 'dspace';
-
+// NOTE: FALLBACK_TEST_REST_BASE_URL is only used if Cypress cannot read the REST API BaseURL
+// from the Angular UI's config.json. See 'before()' above.
+const FALLBACK_TEST_REST_BASE_URL = 'http://localhost:8080/server';
+const FALLBACK_TEST_REST_DOMAIN = 'localhost';
// USEFUL REGEX for testing
diff --git a/docker/README.md b/docker/README.md
index 42deb793f9..37d071a86f 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -101,8 +101,8 @@ and the backend at http://localhost:8080/server/
## Run DSpace Angular dist build with DSpace Demo site backend
-This allows you to run the Angular UI in *production* mode, pointing it at the demo backend
-(https://api7.dspace.org/server/).
+This allows you to run the Angular UI in *production* mode, pointing it at the demo or sandbox backend
+(https://demo.dspace.org/server/ or https://sandbox.dspace.org/server/).
```
docker-compose -f docker/docker-compose-dist.yml pull
diff --git a/docker/cli.assetstore.yml b/docker/cli.assetstore.yml
index 40e4974c7c..98f7414861 100644
--- a/docker/cli.assetstore.yml
+++ b/docker/cli.assetstore.yml
@@ -12,15 +12,8 @@
# https://github.com/DSpace/DSpace/blob/main/dspace/src/main/docker-compose/cli.assetstore.yml
#
# Therefore, it should be kept in sync with that file
-version: "3.7"
-
-networks:
- dspacenet:
-
services:
dspace-cli:
- networks:
- dspacenet: {}
environment:
# This assetstore zip is available from https://github.com/DSpace-Labs/AIP-Files/releases/tag/demo-entities-data
- LOADASSETS=https://github.com/DSpace-Labs/AIP-Files/releases/download/demo-entities-data/assetstore.tar.gz
diff --git a/docker/cli.ingest.yml b/docker/cli.ingest.yml
index 1db241af3b..cc3623298e 100644
--- a/docker/cli.ingest.yml
+++ b/docker/cli.ingest.yml
@@ -12,8 +12,6 @@
# https://github.com/DSpace/DSpace/blob/main/dspace/src/main/docker-compose/cli.ingest.yml
#
# Therefore, it should be kept in sync with that file
-version: "3.7"
-
services:
dspace-cli:
environment:
diff --git a/docker/cli.yml b/docker/cli.yml
index 54b83d4503..11fe2ee662 100644
--- a/docker/cli.yml
+++ b/docker/cli.yml
@@ -12,11 +12,16 @@
# https://github.com/DSpace/DSpace/blob/main/docker-compose-cli.yml
#
# Therefore, it should be kept in sync with that file
-version: "3.7"
-
+networks:
+ # Default to using network named 'dspacenet' from docker-compose-rest.yml.
+ # Its full name will be prepended with the project name (e.g. "-p d7" means it will be named "d7_dspacenet")
+ # If COMPOSITE_PROJECT_NAME is missing, default value will be "docker" (name of folder this file is in)
+ default:
+ name: ${COMPOSE_PROJECT_NAME:-docker}_dspacenet
+ external: true
services:
dspace-cli:
- image: "${DOCKER_OWNER:-dspace}/dspace-cli:${DSPACE_VER:-dspace-7_x}"
+ image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace-cli:${DSPACE_VER:-dspace-7_x}"
container_name: dspace-cli
environment:
# Below syntax may look odd, but it is how to override dspace.cfg settings via env variables.
@@ -30,16 +35,12 @@ services:
# solr.server: Ensure we are using the 'dspacesolr' image for Solr
solr__P__server: http://dspacesolr:8983/solr
volumes:
- - "assetstore:/dspace/assetstore"
+ # Keep DSpace assetstore directory between reboots
+ - assetstore:/dspace/assetstore
entrypoint: /dspace/bin/dspace
command: help
- networks:
- - dspacenet
tty: true
stdin_open: true
volumes:
assetstore:
-
-networks:
- dspacenet:
diff --git a/docker/db.entities.yml b/docker/db.entities.yml
index 6473bf2e38..26d848e022 100644
--- a/docker/db.entities.yml
+++ b/docker/db.entities.yml
@@ -12,11 +12,9 @@
# https://github.com/DSpace/DSpace/blob/main/dspace/src/main/docker-compose/db.entities.yml
#
# # Therefore, it should be kept in sync with that file
-version: "3.7"
-
services:
dspacedb:
- image: dspace/dspace-postgres-pgcrypto:loadsql
+ image: ${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace-postgres-pgcrypto:${DSPACE_VER:-dspace-7_x}-loadsql
environment:
# This LOADSQL should be kept in sync with the URL in DSpace/DSpace
# This SQL is available from https://github.com/DSpace-Labs/AIP-Files/releases/tag/demo-entities-data
diff --git a/docker/docker-compose-ci.yml b/docker/docker-compose-ci.yml
index 9ec8fe664a..e09d88b472 100644
--- a/docker/docker-compose-ci.yml
+++ b/docker/docker-compose-ci.yml
@@ -10,7 +10,6 @@
# This is used by our GitHub CI at .github/workflows/build.yml
# It is based heavily on the Backend's Docker Compose:
# https://github.com/DSpace/DSpace/blob/main/docker-compose.yml
-version: '3.7'
networks:
dspacenet:
services:
@@ -33,11 +32,12 @@ services:
# Tell Statistics to commit all views immediately instead of waiting on Solr's autocommit.
# This allows us to generate statistics in e2e tests so that statistics pages can be tested thoroughly.
solr__D__statistics__P__autoCommit: 'false'
+ LOGGING_CONFIG: /dspace/config/log4j2-container.xml
+ image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace:${DSPACE_VER:-dspace-7_x-test}"
depends_on:
- dspacedb
- image: dspace/dspace:dspace-7_x-test
networks:
- dspacenet:
+ - dspacenet
ports:
- published: 8080
target: 8080
@@ -45,8 +45,6 @@ services:
tty: true
volumes:
- assetstore:/dspace/assetstore
- # Mount DSpace's solr configs to a volume, so that we can share to 'dspacesolr' container (see below)
- - solr_configs:/dspace/solr
# Ensure that the database is ready BEFORE starting tomcat
# 1. While a TCP connection to dspacedb port 5432 is not available, continue to sleep
# 2. Then, run database migration to init database tables (including any out-of-order ignored migrations, if any)
@@ -62,29 +60,30 @@ services:
# NOTE: This is customized to use our loadsql image, so that we are using a database with existing test data
dspacedb:
container_name: dspacedb
+ image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace-postgres-pgcrypto:${DSPACE_VER:-dspace-7_x}-loadsql"
environment:
# This LOADSQL should be kept in sync with the LOADSQL in
# https://github.com/DSpace/DSpace/blob/main/dspace/src/main/docker-compose/db.entities.yml
# This SQL is available from https://github.com/DSpace-Labs/AIP-Files/releases/tag/demo-entities-data
LOADSQL: https://github.com/DSpace-Labs/AIP-Files/releases/download/demo-entities-data/dspace7-entities-data.sql
PGDATA: /pgdata
- image: dspace/dspace-postgres-pgcrypto:loadsql
+ POSTGRES_PASSWORD: dspace
networks:
- dspacenet:
+ - dspacenet
+ ports:
+ - published: 5432
+ target: 5432
stdin_open: true
tty: true
volumes:
+ # Keep Postgres data directory between reboots
- pgdata:/pgdata
# DSpace Solr container
dspacesolr:
container_name: dspacesolr
- # Uses official Solr image at https://hub.docker.com/_/solr/
- image: solr:8.11-slim
- # Needs main 'dspace' container to start first to guarantee access to solr_configs
- depends_on:
- - dspace
+ image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace-solr:${DSPACE_VER:-dspace-7_x}"
networks:
- dspacenet:
+ - dspacenet
ports:
- published: 8983
target: 8983
@@ -92,9 +91,6 @@ services:
tty: true
working_dir: /var/solr/data
volumes:
- # Mount our "solr_configs" volume available under the Solr's configsets folder (in a 'dspace' subfolder)
- # This copies the Solr configs from main 'dspace' container into 'dspacesolr' via that volume
- - solr_configs:/opt/solr/server/solr/configsets/dspace
# Keep Solr data directory between reboots
- solr_data:/var/solr/data
# Initialize all DSpace Solr cores using the mounted configsets (see above), then start Solr
@@ -103,14 +99,16 @@ services:
- '-c'
- |
init-var-solr
- precreate-core authority /opt/solr/server/solr/configsets/dspace/authority
- precreate-core oai /opt/solr/server/solr/configsets/dspace/oai
- precreate-core search /opt/solr/server/solr/configsets/dspace/search
- precreate-core statistics /opt/solr/server/solr/configsets/dspace/statistics
+ precreate-core authority /opt/solr/server/solr/configsets/authority
+ cp -r /opt/solr/server/solr/configsets/authority/* authority
+ precreate-core oai /opt/solr/server/solr/configsets/oai
+ cp -r /opt/solr/server/solr/configsets/oai/* oai
+ precreate-core search /opt/solr/server/solr/configsets/search
+ cp -r /opt/solr/server/solr/configsets/search/* search
+ precreate-core statistics /opt/solr/server/solr/configsets/statistics
+ cp -r /opt/solr/server/solr/configsets/statistics/* statistics
exec solr -f
volumes:
assetstore:
pgdata:
solr_data:
- # Special volume used to share Solr configs from 'dspace' to 'dspacesolr' container (see above)
- solr_configs:
\ No newline at end of file
diff --git a/docker/docker-compose-dist.yml b/docker/docker-compose-dist.yml
index 1c75539da9..88e5be16a5 100644
--- a/docker/docker-compose-dist.yml
+++ b/docker/docker-compose-dist.yml
@@ -8,7 +8,6 @@
# Docker Compose for running the DSpace Angular UI dist build
# for previewing with the DSpace Demo site backend
-version: '3.7'
networks:
dspacenet:
services:
@@ -24,10 +23,10 @@ services:
# This is because Server Side Rendering (SSR) currently requires a public URL,
# see this bug: https://github.com/DSpace/dspace-angular/issues/1485
DSPACE_REST_SSL: 'true'
- DSPACE_REST_HOST: api7.dspace.org
+ DSPACE_REST_HOST: demo.dspace.org
DSPACE_REST_PORT: 443
DSPACE_REST_NAMESPACE: /server
- image: dspace/dspace-angular:dspace-7_x-dist
+ image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace-angular:${DSPACE_VER:-dspace-7_x}-dist"
build:
context: ..
dockerfile: Dockerfile.dist
diff --git a/docker/docker-compose-rest.yml b/docker/docker-compose-rest.yml
index e5f62600e7..19d4d3c604 100644
--- a/docker/docker-compose-rest.yml
+++ b/docker/docker-compose-rest.yml
@@ -10,7 +10,6 @@
# This is based heavily on the docker-compose.yml that is available in the DSpace/DSpace
# (Backend) at:
# https://github.com/DSpace/DSpace/blob/main/docker-compose.yml
-version: '3.7'
networks:
dspacenet:
ipam:
@@ -29,8 +28,9 @@ services:
# __D__ => "-" (e.g. google__D__metadata => google-metadata)
# dspace.dir, dspace.server.url, dspace.ui.url and dspace.name
dspace__P__dir: /dspace
- dspace__P__server__P__url: http://localhost:8080/server
- dspace__P__ui__P__url: http://localhost:4000
+ # Uncomment to set a non-default value for dspace.server.url or dspace.ui.url
+ # dspace__P__server__P__url: http://localhost:8080/server
+ # dspace__P__ui__P__url: http://localhost:4000
dspace__P__name: 'DSpace Started with Docker Compose'
# db.url: Ensure we are using the 'dspacedb' image for our database
db__P__url: 'jdbc:postgresql://dspacedb:5432/dspace'
@@ -39,11 +39,12 @@ services:
# proxies.trusted.ipranges: This setting is required for a REST API running in Docker to trust requests
# from the host machine. This IP range MUST correspond to the 'dspacenet' subnet defined above.
proxies__P__trusted__P__ipranges: '172.23.0'
- image: "${DOCKER_OWNER:-dspace}/dspace:${DSPACE_VER:-dspace-7_x-test}"
+ LOGGING_CONFIG: /dspace/config/log4j2-container.xml
+ image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace:${DSPACE_VER:-dspace-7_x-test}"
depends_on:
- dspacedb
networks:
- dspacenet:
+ - dspacenet
ports:
- published: 8080
target: 8080
@@ -51,8 +52,6 @@ services:
tty: true
volumes:
- assetstore:/dspace/assetstore
- # Mount DSpace's solr configs to a volume, so that we can share to 'dspacesolr' container (see below)
- - solr_configs:/dspace/solr
# Ensure that the database is ready BEFORE starting tomcat
# 1. While a TCP connection to dspacedb port 5432 is not available, continue to sleep
# 2. Then, run database migration to init database tables
@@ -67,27 +66,27 @@ services:
# DSpace database container
dspacedb:
container_name: dspacedb
+ # Uses a custom Postgres image with pgcrypto installed
+ image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace-postgres-pgcrypto:${DSPACE_VER:-dspace-7_x}"
environment:
PGDATA: /pgdata
- image: dspace/dspace-postgres-pgcrypto
+ POSTGRES_PASSWORD: dspace
networks:
- dspacenet:
+ - dspacenet
ports:
- published: 5432
target: 5432
stdin_open: true
tty: true
volumes:
+ # Keep Postgres data directory between reboots
- pgdata:/pgdata
# DSpace Solr container
dspacesolr:
container_name: dspacesolr
- image: "${DOCKER_OWNER:-dspace}/dspace-solr:${DSPACE_VER:-dspace-7_x}"
- # Needs main 'dspace' container to start first to guarantee access to solr_configs
- depends_on:
- - dspace
+ image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace-solr:${DSPACE_VER:-dspace-7_x}"
networks:
- dspacenet:
+ - dspacenet
ports:
- published: 8983
target: 8983
@@ -120,5 +119,3 @@ volumes:
assetstore:
pgdata:
solr_data:
- # Special volume used to share Solr configs from 'dspace' to 'dspacesolr' container (see above)
- solr_configs:
diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
index 1387b1de39..90a1d0c21c 100644
--- a/docker/docker-compose.yml
+++ b/docker/docker-compose.yml
@@ -9,7 +9,6 @@
# Docker Compose for running the DSpace Angular UI for testing/development
# Requires also running a REST API backend (either locally or remotely),
# for example via 'docker-compose-rest.yml'
-version: '3.7'
networks:
dspacenet:
services:
@@ -24,7 +23,7 @@ services:
DSPACE_REST_HOST: localhost
DSPACE_REST_PORT: 8080
DSPACE_REST_NAMESPACE: /server
- image: dspace/dspace-angular:dspace-7_x
+ image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace-angular:${DSPACE_VER:-dspace-7_x}"
build:
context: ..
dockerfile: Dockerfile
diff --git a/docs/Configuration.md b/docs/Configuration.md
index 62fa444cc0..01fd83c94d 100644
--- a/docs/Configuration.md
+++ b/docs/Configuration.md
@@ -48,7 +48,7 @@ dspace-angular connects to your DSpace installation by using its REST endpoint.
```yaml
rest:
ssl: true
- host: api7.dspace.org
+ host: demo.dspace.org
port: 443
nameSpace: /server
}
@@ -57,7 +57,7 @@ rest:
Alternately you can set the following environment variables. If any of these are set, it will override all configuration files:
```
DSPACE_REST_SSL=true
- DSPACE_REST_HOST=api7.dspace.org
+ DSPACE_REST_HOST=demo.dspace.org
DSPACE_REST_PORT=443
DSPACE_REST_NAMESPACE=/server
```
diff --git a/package.json b/package.json
index 719b13b23b..a9fc04b7ab 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "dspace-angular",
- "version": "7.6.0",
+ "version": "7.6.4-next",
"scripts": {
"ng": "ng",
"config:watch": "nodemon",
@@ -12,17 +12,16 @@
"preserve": "yarn base-href",
"serve": "ts-node --project ./tsconfig.ts-node.json scripts/serve.ts",
"serve:ssr": "node dist/server/main",
- "analyze": "webpack-bundle-analyzer dist/browser/stats.json",
"build": "ng build --configuration development",
"build:stats": "ng build --stats-json",
- "build:prod": "yarn run build:ssr",
+ "build:prod": "cross-env NODE_ENV=production yarn run build:ssr",
"build:ssr": "ng build --configuration production && ng run dspace-angular:server:production",
"test": "ng test --source-map=true --watch=false --configuration test",
"test:watch": "nodemon --exec \"ng test --source-map=true --watch=true --configuration test\"",
"test:headless": "ng test --source-map=true --watch=false --configuration test --browsers=ChromeHeadless --code-coverage",
"lint": "ng lint",
"lint-fix": "ng lint --fix=true",
- "e2e": "ng e2e",
+ "e2e": "cross-env NODE_ENV=production ng e2e",
"clean:dev:config": "rimraf src/assets/config.json",
"clean:coverage": "rimraf coverage",
"clean:dist": "rimraf dist",
@@ -49,27 +48,20 @@
"https": false
},
"private": true,
- "resolutions": {
- "minimist": "^1.2.5",
- "webdriver-manager": "^12.1.8",
- "ts-node": "10.2.1"
- },
"dependencies": {
- "@angular/animations": "^15.2.8",
- "@angular/cdk": "^15.2.8",
- "@angular/common": "^15.2.8",
- "@angular/compiler": "^15.2.8",
- "@angular/core": "^15.2.8",
- "@angular/forms": "^15.2.8",
- "@angular/localize": "15.2.8",
- "@angular/platform-browser": "^15.2.8",
- "@angular/platform-browser-dynamic": "^15.2.8",
- "@angular/platform-server": "^15.2.8",
- "@angular/router": "^15.2.8",
- "@babel/runtime": "7.21.0",
+ "@angular/animations": "^15.2.10",
+ "@angular/cdk": "^15.2.9",
+ "@angular/common": "^15.2.10",
+ "@angular/compiler": "^15.2.10",
+ "@angular/core": "^15.2.10",
+ "@angular/forms": "^15.2.10",
+ "@angular/localize": "15.2.10",
+ "@angular/platform-browser": "^15.2.10",
+ "@angular/platform-browser-dynamic": "^15.2.10",
+ "@angular/platform-server": "^15.2.10",
+ "@angular/router": "^15.2.10",
+ "@babel/runtime": "7.27.1",
"@kolkov/ngx-gallery": "^2.0.1",
- "@material-ui/core": "^4.11.0",
- "@material-ui/icons": "^4.11.3",
"@ng-bootstrap/ng-bootstrap": "^11.0.0",
"@ng-dynamic-forms/core": "^15.0.0",
"@ng-dynamic-forms/ui-ng-bootstrap": "^15.0.0",
@@ -79,129 +71,129 @@
"@nguniversal/express-engine": "^15.2.1",
"@ngx-translate/core": "^14.0.0",
"@nicky-lenaers/ngx-scroll-to": "^14.0.0",
- "@types/grecaptcha": "^3.0.4",
"angular-idle-preload": "3.0.0",
- "angulartics2": "^12.2.0",
- "axios": "^0.27.2",
+ "angulartics2": "^12.2.1",
+ "axios": "^1.9.0",
"bootstrap": "^4.6.1",
"cerialize": "0.1.18",
"cli-progress": "^3.12.0",
"colors": "^1.4.0",
- "compression": "^1.7.4",
- "cookie-parser": "1.4.6",
- "core-js": "^3.30.1",
- "date-fns": "^2.29.3",
+ "compression": "^1.8.0",
+ "cookie-parser": "1.4.7",
+ "core-js": "^3.42.0",
+ "date-fns": "^2.30.0",
"date-fns-tz": "^1.3.7",
"deepmerge": "^4.3.1",
- "ejs": "^3.1.9",
- "express": "^4.18.2",
+ "ejs": "^3.1.10",
+ "express": "^4.21.2",
"express-rate-limit": "^5.1.3",
"fast-json-patch": "^3.1.1",
"filesize": "^6.1.0",
- "http-proxy-middleware": "^1.0.5",
- "isbot": "^3.6.10",
+ "http-proxy-middleware": "^2.0.9",
+ "http-terminator": "^3.2.0",
+ "isbot": "^5.1.28",
"js-cookie": "2.2.1",
"js-yaml": "^4.1.0",
"json5": "^2.2.3",
- "jsonschema": "1.4.1",
+ "jsonschema": "1.5.0",
"jwt-decode": "^3.1.2",
- "klaro": "^0.7.18",
+ "klaro": "^0.7.21",
"lodash": "^4.17.21",
"lru-cache": "^7.14.1",
- "markdown-it": "^13.0.1",
+ "markdown-it": "^13.0.2",
"markdown-it-mathjax3": "^4.3.2",
- "mirador": "^3.3.0",
+ "mirador": "^3.4.3",
"mirador-dl-plugin": "^0.13.0",
- "mirador-share-plugin": "^0.11.0",
+ "mirador-share-plugin": "^0.16.0",
"morgan": "^1.10.0",
- "ng-mocks": "^14.10.0",
"ng2-file-upload": "1.4.0",
- "ng2-nouislider": "^1.8.3",
+ "ng2-nouislider": "^2.0.0",
"ngx-infinite-scroll": "^15.0.0",
"ngx-pagination": "6.0.3",
+ "ngx-skeleton-loader": "^7.0.0",
"ngx-sortablejs": "^11.1.0",
- "ngx-ui-switch": "^14.0.3",
- "nouislider": "^14.6.3",
- "pem": "1.14.7",
- "prop-types": "^15.8.1",
- "react-copy-to-clipboard": "^5.1.0",
- "reflect-metadata": "^0.1.13",
- "rxjs": "^7.8.0",
- "sanitize-html": "^2.10.0",
- "sortablejs": "1.15.0",
+ "ngx-ui-switch": "^14.1.0",
+ "nouislider": "^15.8.1",
+ "pem": "1.14.8",
+ "reflect-metadata": "^0.2.2",
+ "rxjs": "^7.8.2",
+ "sanitize-html": "^2.16.0",
+ "sortablejs": "1.15.6",
"uuid": "^8.3.2",
- "webfontloader": "1.6.28",
- "zone.js": "~0.11.5"
+ "zone.js": "~0.13.3"
},
"devDependencies": {
"@angular-builders/custom-webpack": "~15.0.0",
- "@angular-devkit/build-angular": "^15.2.6",
+ "@angular-devkit/build-angular": "^15.2.11",
"@angular-eslint/builder": "15.2.1",
"@angular-eslint/eslint-plugin": "15.2.1",
"@angular-eslint/eslint-plugin-template": "15.2.1",
"@angular-eslint/schematics": "15.2.1",
"@angular-eslint/template-parser": "15.2.1",
- "@angular/cli": "^15.2.6",
- "@angular/compiler-cli": "^15.2.8",
- "@angular/language-service": "^15.2.8",
+ "@angular/cli": "^16.2.16",
+ "@angular/compiler-cli": "^15.2.10",
+ "@angular/language-service": "^15.2.10",
"@cypress/schematic": "^1.5.0",
- "@fortawesome/fontawesome-free": "^6.4.0",
+ "@fortawesome/fontawesome-free": "^6.7.2",
+ "@material-ui/core": "^4.12.4",
+ "@material-ui/icons": "^4.11.3",
"@ngrx/store-devtools": "^15.4.0",
"@ngtools/webpack": "^15.2.6",
"@nguniversal/builders": "^15.2.1",
- "@types/deep-freeze": "0.1.2",
- "@types/ejs": "^3.1.2",
- "@types/express": "^4.17.17",
+ "@types/deep-freeze": "0.1.5",
+ "@types/ejs": "^3.1.5",
+ "@types/express": "^4.17.21",
+ "@types/grecaptcha": "^3.0.9",
"@types/jasmine": "~3.6.0",
"@types/js-cookie": "2.2.6",
- "@types/lodash": "^4.14.194",
- "@types/node": "^14.14.9",
- "@types/sanitize-html": "^2.9.0",
- "@typescript-eslint/eslint-plugin": "^5.59.1",
- "@typescript-eslint/parser": "^5.59.1",
- "axe-core": "^4.7.0",
+ "@types/lodash": "^4.17.16",
+ "@types/node": "^14.18.63",
+ "@types/sanitize-html": "^2.16.0",
+ "@typescript-eslint/eslint-plugin": "^5.62.0",
+ "@typescript-eslint/parser": "^5.62.0",
+ "axe-core": "^4.10.3",
"compression-webpack-plugin": "^9.2.0",
"copy-webpack-plugin": "^6.4.1",
"cross-env": "^7.0.3",
- "cypress": "12.10.0",
- "cypress-axe": "^1.4.0",
+ "csstype": "^3.1.3",
+ "cypress": "^13.17.0",
+ "cypress-axe": "^1.6.0",
"deep-freeze": "0.0.1",
"eslint": "^8.39.0",
- "eslint-plugin-deprecation": "^1.4.1",
- "eslint-plugin-import": "^2.27.5",
- "eslint-plugin-jsdoc": "^39.6.4",
- "eslint-plugin-jsonc": "^2.6.0",
+ "eslint-plugin-deprecation": "^1.5.0",
+ "eslint-plugin-import": "^2.31.0",
+ "eslint-plugin-jsdoc": "^45.0.0",
+ "eslint-plugin-jsonc": "^2.20.1",
"eslint-plugin-lodash": "^7.4.0",
"eslint-plugin-unused-imports": "^2.0.0",
- "express-static-gzip": "^2.1.7",
+ "express-static-gzip": "^2.2.0",
"jasmine-core": "^3.8.0",
"jasmine-marbles": "0.9.2",
- "karma": "^6.4.2",
+ "karma": "^6.4.4",
"karma-chrome-launcher": "~3.2.0",
"karma-coverage-istanbul-reporter": "~3.0.3",
"karma-jasmine": "~4.0.0",
"karma-jasmine-html-reporter": "^1.5.0",
"karma-mocha-reporter": "2.2.5",
+ "ng-mocks": "^14.13.4",
"ngx-mask": "^13.1.7",
"nodemon": "^2.0.22",
- "postcss": "^8.4",
- "postcss-apply": "0.12.0",
+ "postcss": "^8.5",
"postcss-import": "^14.0.0",
"postcss-loader": "^4.0.3",
"postcss-preset-env": "^7.4.2",
- "postcss-responsive-type": "1.0.0",
+ "prop-types": "^15.8.1",
"react": "^16.14.0",
+ "react-copy-to-clipboard": "^5.1.0",
"react-dom": "^16.14.0",
"rimraf": "^3.0.2",
- "rxjs-spy": "^8.0.2",
- "sass": "~1.62.0",
+ "sass": "~1.89.0",
"sass-loader": "^12.6.0",
"sass-resources-loader": "^2.2.5",
"ts-node": "^8.10.2",
"typescript": "~4.8.4",
"webpack": "5.76.1",
- "webpack-bundle-analyzer": "^4.8.0",
"webpack-cli": "^4.2.0",
- "webpack-dev-server": "^4.13.3"
+ "webpack-dev-server": "^4.15.2"
}
}
diff --git a/postcss.config.js b/postcss.config.js
index df092d1d39..f8b9666b31 100644
--- a/postcss.config.js
+++ b/postcss.config.js
@@ -1,8 +1,6 @@
module.exports = {
plugins: [
require('postcss-import')(),
- require('postcss-preset-env')(),
- require('postcss-apply')(),
- require('postcss-responsive-type')()
+ require('postcss-preset-env')()
]
};
diff --git a/server.ts b/server.ts
index 23327c2058..1aee5dc657 100644
--- a/server.ts
+++ b/server.ts
@@ -28,10 +28,11 @@ import * as expressStaticGzip from 'express-static-gzip';
/* eslint-enable import/no-namespace */
import axios from 'axios';
import LRU from 'lru-cache';
-import isbot from 'isbot';
+import { isbot } from 'isbot';
import { createCertificate } from 'pem';
import { createServer } from 'https';
import { json } from 'body-parser';
+import { createHttpTerminator } from 'http-terminator';
import { readFileSync } from 'fs';
import { join } from 'path';
@@ -54,6 +55,7 @@ import { APP_CONFIG, AppConfig } from './src/config/app-config.interface';
import { extendEnvironmentWithAppConfig } from './src/config/config.util';
import { logStartupMessage } from './startup-message';
import { TOKENITEM } from './src/app/core/auth/models/auth-token-info.model';
+import { SsrExcludePatterns } from './src/config/universal-config.interface';
/*
@@ -78,6 +80,9 @@ let anonymousCache: LRU;
// extend environment with app config for server
extendEnvironmentWithAppConfig(environment, appConfig);
+// The REST server base URL
+const REST_BASE_URL = environment.rest.ssrBaseUrl || environment.rest.baseUrl;
+
// The Express app is exported so that it can be used by serverless Functions.
export function app() {
@@ -130,6 +135,7 @@ export function app() {
server.engine('html', (_, options, callback) =>
ngExpressEngine({
bootstrap: ServerAppModule,
+ inlineCriticalCss: environment.universal.inlineCriticalCss,
providers: [
{
provide: REQUEST,
@@ -174,7 +180,7 @@ export function app() {
* Proxy the sitemaps
*/
router.use('/sitemap**', createProxyMiddleware({
- target: `${environment.rest.baseUrl}/sitemaps`,
+ target: `${REST_BASE_URL}/sitemaps`,
pathRewrite: path => path.replace(environment.ui.nameSpace, '/'),
changeOrigin: true
}));
@@ -183,7 +189,7 @@ export function app() {
* Proxy the linksets
*/
router.use('/signposting**', createProxyMiddleware({
- target: `${environment.rest.baseUrl}`,
+ target: `${REST_BASE_URL}`,
pathRewrite: path => path.replace(environment.ui.nameSpace, '/'),
changeOrigin: true
}));
@@ -236,7 +242,7 @@ export function app() {
* The callback function to serve server side angular
*/
function ngApp(req, res) {
- if (environment.universal.preboot) {
+ if (environment.universal.preboot && req.method === 'GET' && (req.path === '/' || !isExcludedFromSsr(req.path, environment.universal.excludePathPatterns))) {
// Render the page to user via SSR (server side rendering)
serverSideRender(req, res);
} else {
@@ -267,6 +273,11 @@ function serverSideRender(req, res, sendToUser: boolean = true) {
requestUrl: req.originalUrl,
}, (err, data) => {
if (hasNoValue(err) && hasValue(data)) {
+ // Replace REST URL with UI URL
+ if (environment.universal.replaceRestUrl && REST_BASE_URL !== environment.rest.baseUrl) {
+ data = data.replace(new RegExp(REST_BASE_URL, 'g'), environment.rest.baseUrl);
+ }
+
// save server side rendered page to cache (if any are enabled)
saveToCache(req, data);
if (sendToUser) {
@@ -320,22 +331,23 @@ function initCache() {
if (botCacheEnabled()) {
// Initialize a new "least-recently-used" item cache (where least recently used pages are removed first)
// See https://www.npmjs.com/package/lru-cache
- // When enabled, each page defaults to expiring after 1 day
+ // When enabled, each page defaults to expiring after 1 day (defined in default-app-config.ts)
botCache = new LRU( {
max: environment.cache.serverSide.botCache.max,
- ttl: environment.cache.serverSide.botCache.timeToLive || 24 * 60 * 60 * 1000, // 1 day
- allowStale: environment.cache.serverSide.botCache.allowStale ?? true // if object is stale, return stale value before deleting
+ ttl: environment.cache.serverSide.botCache.timeToLive,
+ allowStale: environment.cache.serverSide.botCache.allowStale
});
}
if (anonymousCacheEnabled()) {
// NOTE: While caches may share SSR pages, this cache must be kept separately because the timeToLive
// may expire pages more frequently.
- // When enabled, each page defaults to expiring after 10 seconds (to minimize anonymous users seeing out-of-date content)
+ // When enabled, each page defaults to expiring after 10 seconds (defined in default-app-config.ts)
+ // to minimize anonymous users seeing out-of-date content
anonymousCache = new LRU( {
max: environment.cache.serverSide.anonymousCache.max,
- ttl: environment.cache.serverSide.anonymousCache.timeToLive || 10 * 1000, // 10 seconds
- allowStale: environment.cache.serverSide.anonymousCache.allowStale ?? true // if object is stale, return stale value before deleting
+ ttl: environment.cache.serverSide.anonymousCache.timeToLive,
+ allowStale: environment.cache.serverSide.anonymousCache.allowStale
});
}
}
@@ -487,7 +499,7 @@ function saveToCache(req, page: any) {
*/
function hasNotSucceeded(statusCode) {
const rgx = new RegExp(/^20+/);
- return !rgx.test(statusCode)
+ return !rgx.test(statusCode);
}
function retrieveHeaders(response) {
@@ -525,23 +537,46 @@ function serverStarted() {
* @param keys SSL credentials
*/
function createHttpsServer(keys) {
- createServer({
+ const listener = createServer({
key: keys.serviceKey,
cert: keys.certificate
}, app).listen(environment.ui.port, environment.ui.host, () => {
serverStarted();
});
+
+ // Graceful shutdown when signalled
+ const terminator = createHttpTerminator({server: listener});
+ process.on('SIGINT', () => {
+ void (async ()=> {
+ console.debug('Closing HTTPS server on signal');
+ await terminator.terminate().catch(e => { console.error(e); });
+ console.debug('HTTPS server closed');
+ })();
+ });
}
+/**
+ * Create an HTTP server with the configured port and host.
+ */
function run() {
const port = environment.ui.port || 4000;
const host = environment.ui.host || '/';
// Start up the Node server
const server = app();
- server.listen(port, host, () => {
+ const listener = server.listen(port, host, () => {
serverStarted();
});
+
+ // Graceful shutdown when signalled
+ const terminator = createHttpTerminator({server: listener});
+ process.on('SIGINT', () => {
+ void (async () => {
+ console.debug('Closing HTTP server on signal');
+ await terminator.terminate().catch(e => { console.error(e); });
+ console.debug('HTTP server closed.');return undefined;
+ })();
+ });
}
function start() {
@@ -591,11 +626,26 @@ function start() {
}
}
+/**
+ * Check if SSR should be skipped for path
+ *
+ * @param path
+ * @param excludePathPattern
+ */
+function isExcludedFromSsr(path: string, excludePathPattern: SsrExcludePatterns[]): boolean {
+ const patterns = excludePathPattern.map(p =>
+ new RegExp(p.pattern, p.flag || '')
+ );
+ return patterns.some((regex) => {
+ return regex.test(path)
+ });
+}
+
/*
* The callback function to serve health check requests
*/
function healthCheck(req, res) {
- const baseUrl = `${environment.rest.baseUrl}${environment.actuators.endpointPath}`;
+ const baseUrl = `${REST_BASE_URL}${environment.actuators.endpointPath}`;
axios.get(baseUrl)
.then((response) => {
res.status(response.status).send(response.data);
diff --git a/src/app/access-control/access-control-routing-paths.ts b/src/app/access-control/access-control-routing-paths.ts
index 259aa311e7..31f39f1c47 100644
--- a/src/app/access-control/access-control-routing-paths.ts
+++ b/src/app/access-control/access-control-routing-paths.ts
@@ -1,12 +1,22 @@
import { URLCombiner } from '../core/url-combiner/url-combiner';
import { getAccessControlModuleRoute } from '../app-routing-paths';
-export const GROUP_EDIT_PATH = 'groups';
+export const EPERSON_PATH = 'epeople';
+
+export function getEPersonsRoute(): string {
+ return new URLCombiner(getAccessControlModuleRoute(), EPERSON_PATH).toString();
+}
+
+export function getEPersonEditRoute(id: string): string {
+ return new URLCombiner(getEPersonsRoute(), id, 'edit').toString();
+}
+
+export const GROUP_PATH = 'groups';
export function getGroupsRoute() {
- return new URLCombiner(getAccessControlModuleRoute(), GROUP_EDIT_PATH).toString();
+ return new URLCombiner(getAccessControlModuleRoute(), GROUP_PATH).toString();
}
export function getGroupEditRoute(id: string) {
- return new URLCombiner(getAccessControlModuleRoute(), GROUP_EDIT_PATH, id).toString();
+ return new URLCombiner(getGroupsRoute(), id, 'edit').toString();
}
diff --git a/src/app/access-control/access-control-routing.module.ts b/src/app/access-control/access-control-routing.module.ts
index 6f6de6cb26..97d049ad83 100644
--- a/src/app/access-control/access-control-routing.module.ts
+++ b/src/app/access-control/access-control-routing.module.ts
@@ -3,7 +3,7 @@ import { RouterModule } from '@angular/router';
import { EPeopleRegistryComponent } from './epeople-registry/epeople-registry.component';
import { GroupFormComponent } from './group-registry/group-form/group-form.component';
import { GroupsRegistryComponent } from './group-registry/groups-registry.component';
-import { GROUP_EDIT_PATH } from './access-control-routing-paths';
+import { EPERSON_PATH, GROUP_PATH } from './access-control-routing-paths';
import { I18nBreadcrumbResolver } from '../core/breadcrumbs/i18n-breadcrumb.resolver';
import { GroupPageGuard } from './group-registry/group-page.guard';
import {
@@ -13,12 +13,14 @@ import {
SiteAdministratorGuard
} from '../core/data/feature-authorization/feature-authorization-guard/site-administrator.guard';
import { BulkAccessComponent } from './bulk-access/bulk-access.component';
+import { EPersonFormComponent } from './epeople-registry/eperson-form/eperson-form.component';
+import { EPersonResolver } from './epeople-registry/eperson-resolver.service';
@NgModule({
imports: [
RouterModule.forChild([
{
- path: 'epeople',
+ path: EPERSON_PATH,
component: EPeopleRegistryComponent,
resolve: {
breadcrumb: I18nBreadcrumbResolver
@@ -27,7 +29,26 @@ import { BulkAccessComponent } from './bulk-access/bulk-access.component';
canActivate: [SiteAdministratorGuard]
},
{
- path: GROUP_EDIT_PATH,
+ path: `${EPERSON_PATH}/create`,
+ component: EPersonFormComponent,
+ resolve: {
+ breadcrumb: I18nBreadcrumbResolver,
+ },
+ data: { title: 'admin.access-control.epeople.add.title', breadcrumbKey: 'admin.access-control.epeople.add' },
+ canActivate: [SiteAdministratorGuard],
+ },
+ {
+ path: `${EPERSON_PATH}/:id/edit`,
+ component: EPersonFormComponent,
+ resolve: {
+ breadcrumb: I18nBreadcrumbResolver,
+ ePerson: EPersonResolver,
+ },
+ data: { title: 'admin.access-control.epeople.edit.title', breadcrumbKey: 'admin.access-control.epeople.edit' },
+ canActivate: [SiteAdministratorGuard],
+ },
+ {
+ path: GROUP_PATH,
component: GroupsRegistryComponent,
resolve: {
breadcrumb: I18nBreadcrumbResolver
@@ -36,7 +57,7 @@ import { BulkAccessComponent } from './bulk-access/bulk-access.component';
canActivate: [GroupAdministratorGuard]
},
{
- path: `${GROUP_EDIT_PATH}/newGroup`,
+ path: `${GROUP_PATH}/create`,
component: GroupFormComponent,
resolve: {
breadcrumb: I18nBreadcrumbResolver
@@ -45,7 +66,7 @@ import { BulkAccessComponent } from './bulk-access/bulk-access.component';
canActivate: [GroupAdministratorGuard]
},
{
- path: `${GROUP_EDIT_PATH}/:groupId`,
+ path: `${GROUP_PATH}/:groupId/edit`,
component: GroupFormComponent,
resolve: {
breadcrumb: I18nBreadcrumbResolver
diff --git a/src/app/access-control/bulk-access/browse/bulk-access-browse.component.html b/src/app/access-control/bulk-access/browse/bulk-access-browse.component.html
index c716aedb8b..131cb49d6b 100644
--- a/src/app/access-control/bulk-access/browse/bulk-access-browse.component.html
+++ b/src/app/access-control/bulk-access/browse/bulk-access-browse.component.html
@@ -1,15 +1,15 @@
-