diff --git a/.eslintrc.json b/.eslintrc.json
index af1b97849b6..1151e6831be 100644
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -8,7 +8,15 @@
"eslint-plugin-deprecation",
"unused-imports",
"eslint-plugin-lodash",
- "eslint-plugin-jsonc"
+ "eslint-plugin-jsonc",
+ "eslint-plugin-rxjs",
+ "eslint-plugin-simple-import-sort",
+ "eslint-plugin-import-newlines",
+ "dspace-angular-ts",
+ "dspace-angular-html"
+ ],
+ "ignorePatterns": [
+ "lint/test/fixture"
],
"overrides": [
{
@@ -18,7 +26,8 @@
"parserOptions": {
"project": [
"./tsconfig.json",
- "./cypress/tsconfig.json"
+ "./cypress/tsconfig.json",
+ "./lint/tsconfig.json"
],
"createDefaultProgram": true
},
@@ -27,17 +36,32 @@
"plugin:@typescript-eslint/recommended",
"plugin:@typescript-eslint/recommended-requiring-type-checking",
"plugin:@angular-eslint/recommended",
- "plugin:@angular-eslint/template/process-inline-templates"
+ "plugin:@angular-eslint/template/process-inline-templates",
+ "plugin:rxjs/recommended"
],
"rules": {
+ "indent": [
+ "error",
+ 2,
+ {
+ "SwitchCase": 1,
+ "ignoredNodes": [
+ "ClassBody.body > PropertyDefinition[decorators.length > 0] > .key"
+ ]
+ }
+ ],
"max-classes-per-file": [
"error",
1
],
"comma-dangle": [
- "off",
+ "error",
"always-multiline"
],
+ "object-curly-spacing": [
+ "error",
+ "always"
+ ],
"eol-last": [
"error",
"always"
@@ -104,15 +128,13 @@
"allowTernary": true
}
],
- "prefer-const": "off", // todo: re-enable & fix errors (more strict than it used to be in TSLint)
+ "prefer-const": "error",
+ "no-case-declarations": "error",
+ "no-extra-boolean-cast": "error",
"prefer-spread": "off",
"no-underscore-dangle": "off",
-
- // todo: disabled rules from eslint:recommended, consider re-enabling & fixing
"no-prototype-builtins": "off",
"no-useless-escape": "off",
- "no-case-declarations": "off",
- "no-extra-boolean-cast": "off",
"@angular-eslint/directive-selector": [
"error",
@@ -139,10 +161,10 @@
}
],
"@angular-eslint/no-attribute-decorator": "error",
- "@angular-eslint/no-forward-ref": "error",
"@angular-eslint/no-output-native": "warn",
"@angular-eslint/no-output-on-prefix": "warn",
"@angular-eslint/no-conflicting-lifecycle": "warn",
+ "@angular-eslint/use-lifecycle-interface": "error",
"@typescript-eslint/no-inferrable-types":[
"error",
@@ -183,7 +205,7 @@
],
"@typescript-eslint/type-annotation-spacing": "error",
"@typescript-eslint/unified-signatures": "error",
- "@typescript-eslint/ban-types": "warn", // todo: deal with {} type issues & re-enable
+ "@typescript-eslint/ban-types": "error",
"@typescript-eslint/no-floating-promises": "warn",
"@typescript-eslint/no-misused-promises": "warn",
"@typescript-eslint/restrict-plus-operands": "warn",
@@ -200,17 +222,65 @@
"@typescript-eslint/no-unsafe-return": "off",
"@typescript-eslint/restrict-template-expressions": "off",
"@typescript-eslint/require-await": "off",
+ "@typescript-eslint/no-base-to-string": [
+ "error",
+ {
+ "ignoredTypeNames": [
+ "ResourceType",
+ "Error"
+ ]
+ }
+ ],
"deprecation/deprecation": "warn",
+ "simple-import-sort/imports": "error",
+ "simple-import-sort/exports": "error",
"import/order": "off",
+ "import/first": "error",
+ "import/newline-after-import": "error",
+ "import/no-duplicates": "error",
"import/no-deprecated": "warn",
"import/no-namespace": "error",
+ "import-newlines/enforce": [
+ "error",
+ {
+ "items": 1,
+ "semi": true,
+ "forceSingleLine": true
+ }
+ ],
+
"unused-imports/no-unused-imports": "error",
"lodash/import-scope": [
"error",
"method"
- ]
+ ],
+
+ "rxjs/no-nested-subscribe": "off", // todo: go over _all_ cases
+
+ // Custom DSpace Angular rules
+ "dspace-angular-ts/themed-component-classes": "error",
+ "dspace-angular-ts/themed-component-selectors": "error",
+ "dspace-angular-ts/themed-component-usages": "error"
+ }
+ },
+ {
+ "files": [
+ "*.spec.ts"
+ ],
+ "parserOptions": {
+ "project": [
+ "./tsconfig.json",
+ "./cypress/tsconfig.json"
+ ],
+ "createDefaultProgram": true
+ },
+ "rules": {
+ "prefer-const": "off",
+
+ // Custom DSpace Angular rules
+ "dspace-angular-ts/themed-component-usages": "error"
}
},
{
@@ -221,9 +291,9 @@
"plugin:@angular-eslint/template/recommended"
],
"rules": {
- // todo: re-enable & fix errors
- "@angular-eslint/template/no-negated-async": "off",
- "@angular-eslint/template/eqeqeq": "off"
+ // Custom DSpace Angular rules
+ "dspace-angular-html/themed-component-usages": "error",
+ "dspace-angular-html/no-disabled-attribute-on-button": "error"
}
},
{
@@ -231,10 +301,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/.gitattributes b/.gitattributes
index 406640bfcc9..b5ad93b1bc6 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -13,4 +13,7 @@
*.css eol=lf
*.scss eol=lf
*.html eol=lf
-*.svg eol=lf
\ No newline at end of file
+*.svg eol=lf
+
+# Generated documentation should have LF line endings to reduce git noise
+docs/lint/**/*.md eol=lf
\ No newline at end of file
diff --git a/.github/disabled-workflows/pull_request_opened.yml b/.github/disabled-workflows/pull_request_opened.yml
deleted file mode 100644
index 0dc718c0b9a..00000000000
--- 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 219074780e3..8e3613acae2 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:
@@ -28,26 +29,33 @@ jobs:
DSPACE_CACHE_SERVERSIDE_ANONYMOUSCACHE_MAX: 0
# Tell Cypress to run e2e tests using the same UI URL
CYPRESS_BASE_URL: http://127.0.0.1:4000
+ # Disable the cookie consent banner in e2e tests to avoid errors because of elements hidden by it
+ DSPACE_INFO_ENABLECOOKIECONSENTPOPUP: false
# When Chrome version is specified, we pin to a specific version of Chrome
# Comment this out to use the latest release
#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 +80,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 }}
@@ -83,8 +91,14 @@ jobs:
- name: Install Yarn dependencies
run: yarn install --frozen-lockfile
+ - name: Build lint plugins
+ run: yarn run build:lint
+
+ - name: Run lint plugin tests
+ run: yarn run test:lint:nobuild
+
- name: Run lint
- run: yarn run lint --quiet
+ run: yarn run lint:nobuild --quiet
- name: Check for circular dependencies
run: yarn run check-circ-deps
@@ -99,26 +113,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 +155,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 +192,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 +316,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 +328,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 35a2e2d24aa..65cffdfcd9f 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,19 +35,19 @@ 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
- name: Initialize CodeQL
- uses: github/codeql-action/init@v2
+ uses: github/codeql-action/init@v3
with:
languages: javascript
# Autobuild attempts to build any compiled languages
- name: Autobuild
- uses: github/codeql-action/autobuild@v2
+ uses: github/codeql-action/autobuild@v3
# Perform GitHub Code Scanning.
- name: Perform CodeQL Analysis
- uses: github/codeql-action/analyze@v2
\ No newline at end of file
+ uses: github/codeql-action/analyze@v3
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
index 9a2c838d83f..bae8c013005 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/main/.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' || '' }}
-
- 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 }}
+ # 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@main
+ 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 }}
+
+ #############################################################
+ # 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@main
+ 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 b4436dca3aa..0a35a6a9504 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 c1396b6f45c..ccc6c401c0b 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 00000000000..857f22755e4
--- /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 00000000000..bbac52af243
--- /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/.gitignore b/.gitignore
index 7d065aca061..ce44f6b3fbe 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
/.angular/cache
+/.nx
/__build__
/__server_build__
/node_modules
diff --git a/Dockerfile b/Dockerfile
index 8fac7495e1f..e395e4b90e2 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 2a6a66fc063..be72de4afc4 100644
--- a/Dockerfile.dist
+++ b/Dockerfile.dist
@@ -2,9 +2,9 @@
# See https://github.com/DSpace/dspace-angular/tree/main/docker for usage details
# Test build:
-# docker build -f Dockerfile.dist -t dspace/dspace-angular:dspace-7_x-dist .
+# docker build -f Dockerfile.dist -t dspace/dspace-angular:dspace-8_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 ebc24f8b918..fe2af85aa40 100644
--- a/README.md
+++ b/README.md
@@ -35,7 +35,7 @@ https://wiki.lyrasis.org/display/DSDOC7x/Installing+DSpace
Quick start
-----------
-**Ensure you're running [Node](https://nodejs.org) `v16.x` or `v18.x`, [npm](https://www.npmjs.com/) >= `v5.x` and [yarn](https://yarnpkg.com) == `v1.x`**
+**Ensure you're running [Node](https://nodejs.org) `v18.x` or `v20.x`, [npm](https://www.npmjs.com/) >= `v10.x` and [yarn](https://yarnpkg.com) == `v1.x`**
```bash
# clone the repo
@@ -90,7 +90,7 @@ Requirements
------------
- [Node.js](https://nodejs.org) and [yarn](https://yarnpkg.com)
-- Ensure you're running node `v16.x` or `v18.x` and yarn == `v1.x`
+- Ensure you're running node `v18.x` or `v20.x` and yarn == `v1.x`
If you have [`nvm`](https://github.com/creationix/nvm#install-script) or [`nvm-windows`](https://github.com/coreybutler/nvm-windows) installed, which is highly recommended, you can run `nvm install --lts && nvm use` to install and start using the latest Node LTS.
diff --git a/angular.json b/angular.json
index ea6f12f8226..89877a3d7e3 100644
--- a/angular.json
+++ b/angular.json
@@ -30,7 +30,6 @@
"lodash",
"jwt-decode",
"uuid",
- "webfontloader",
"zone.js"
],
"outputPath": "dist/browser",
@@ -114,22 +113,22 @@
"serve": {
"builder": "@angular-builders/custom-webpack:dev-server",
"options": {
- "browserTarget": "dspace-angular:build",
+ "buildTarget": "dspace-angular:build",
"port": 4000
},
"configurations": {
"development": {
- "browserTarget": "dspace-angular:build:development"
+ "buildTarget": "dspace-angular:build:development"
},
"production": {
- "browserTarget": "dspace-angular:build:production"
+ "buildTarget": "dspace-angular:build:production"
}
}
},
"extract-i18n": {
"builder": "@angular-devkit/build-angular:extract-i18n",
"options": {
- "browserTarget": "dspace-angular:build"
+ "buildTarget": "dspace-angular:build"
}
},
"test": {
@@ -222,23 +221,23 @@
}
},
"serve-ssr": {
- "builder": "@nguniversal/builders:ssr-dev-server",
+ "builder": "@angular-devkit/build-angular:ssr-dev-server",
"options": {
- "browserTarget": "dspace-angular:build",
+ "buildTarget": "dspace-angular:build",
"serverTarget": "dspace-angular:server",
"port": 4000
},
"configurations": {
"production": {
- "browserTarget": "dspace-angular:build:production",
+ "buildTarget": "dspace-angular:build:production",
"serverTarget": "dspace-angular:server:production"
}
}
},
"prerender": {
- "builder": "@nguniversal/builders:prerender",
+ "builder": "@angular-devkit/build-angular:prerender",
"options": {
- "browserTarget": "dspace-angular:build:production",
+ "buildTarget": "dspace-angular:build:production",
"serverTarget": "dspace-angular:server:production",
"routes": [
"/"
@@ -271,6 +270,8 @@
"options": {
"lintFilePatterns": [
"src/**/*.ts",
+ "cypress/**/*.ts",
+ "lint/**/*.ts",
"src/**/*.html",
"src/**/*.json5"
]
diff --git a/config/config.example.yml b/config/config.example.yml
index 42c61235b9b..8ea58b96e40 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,64 @@ ui:
# Trust X-FORWARDED-* headers from proxies (default = true)
useProxies: true
+# Angular Server Side Rendering (SSR) settings
+ssr:
+ # 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
+ # Enable request performance profiling data collection and printing the results in the server console.
+ # Defaults to false. Enabling in production is NOT recommended
+ #enablePerformanceProfiler: false
+
# 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: demo.dspace.org
+ host: sandbox.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 +124,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.
@@ -131,12 +180,16 @@ submission:
# NOTE: after how many time (milliseconds) submission is saved automatically
# eg. timer: 5 * (1000 * 60); // 5 minutes
timer: 0
+ # Always show the duplicate detection section if enabled, even if there are no potential duplicates detected
+ # (a message will be displayed to indicate no matches were found)
+ duplicateDetection:
+ alwaysShowSection: false
icons:
metadata:
# NOTE: example of configuration
# # NOTE: metadata name
# - name: dc.author
- # # NOTE: fontawesome (v5.x) icon classes and bootstrap utility classes can be used
+ # # NOTE: fontawesome (v6.x) icon classes and bootstrap utility classes can be used
# style: fas fa-user
- name: dc.author
style: fas fa-user
@@ -147,18 +200,40 @@ submission:
confidence:
# NOTE: example of configuration
# # NOTE: confidence value
- # - name: dc.author
- # # NOTE: fontawesome (v5.x) icon classes and bootstrap utility classes can be used
- # style: fa-user
+ # - value: 600
+ # # NOTE: fontawesome (v6.x) icon classes and bootstrap utility classes can be used
+ # style: text-success
+ # icon: fa-circle-check
+ # # NOTE: the class configured in property style is used by default, the icon property could be used in component
+ # configured to use a 'icon mode' display (mainly in edit-item page)
- value: 600
style: text-success
+ icon: fa-circle-check
- value: 500
style: text-info
+ icon: fa-gear
- value: 400
style: text-warning
+ icon: fa-circle-question
+ - value: 300
+ style: text-muted
+ icon: fa-thumbs-down
+ - value: 200
+ style: text-muted
+ icon: fa-circle-exclamation
+ - value: 100
+ style: text-muted
+ icon: fa-circle-stop
+ - value: 0
+ style: text-muted
+ icon: fa-ban
+ - value: -1
+ style: text-muted
+ icon: fa-circle-xmark
# default configuration
- value: default
style: text-muted
+ icon: fa-circle-xmark
# Default Language in which the UI will be rendered if the user's browser language is not an active language
defaultLanguage: en
@@ -169,6 +244,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 +259,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: 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: hu
- label: Magyar
- active: true
- code: nl
label: Nederlands
active: true
@@ -211,8 +304,8 @@ languages:
- code: sr-lat
label: Srpski (lat)
active: true
- - code: fi
- label: Suomi
+ - code: sr-cyr
+ label: Српски
active: true
- code: sv
label: Svenska
@@ -220,24 +313,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
@@ -269,6 +350,8 @@ homePage:
# No. of communities to list per page on the home page
# This will always round to the nearest number from the list of page sizes. e.g. if you set it to 7 it'll use 10
pageSize: 5
+ # Enable or disable the Discover filters on the homepage
+ showDiscoverFilters: false
# Item Config
item:
@@ -282,8 +365,25 @@ item:
# settings menu. See pageSizeOptions in 'pagination-component-options.model.ts'.
pageSize: 5
+# Community Page Config
+community:
+ # Default tab to be shown when browsing a Community. Valid values are: comcols, search, or browse_
+ # must be any of the configured "browse by" fields, e.g., dateissued, author, title, or subject
+ # When the default tab is not the 'search' tab, the search tab is moved to the last position
+ defaultBrowseTab: search
+ # Search tab config
+ searchSection:
+ showSidebar: true
+
# Collection Page Config
collection:
+ # Default tab to be shown when browsing a Collection. Valid values are: search, or browse_
+ # must be any of the configured "browse by" fields, e.g., dateissued, author, title, or subject
+ # When the default tab is not the 'search' tab, the search tab is moved to the last position
+ defaultBrowseTab: search
+ # Search tab config
+ searchSection:
+ showSidebar: true
edit:
undoTimeout: 10000 # 10 seconds
@@ -360,10 +460,11 @@ mediaViewer:
# Whether the end user agreement is required before users use the repository.
# If enabled, the user will be required to accept the agreement before they can use the repository.
-# And whether the privacy statement should exist or not.
+# And whether the privacy statement/COAR notify support page should exist or not.
info:
enableEndUserAgreement: true
enablePrivacyStatement: true
+ enableCOARNotifySupport: true
# Whether to enable Markdown (https://commonmark.org/) and MathJax (https://www.mathjax.org/)
# display in supported metadata fields. By default, only dc.description.abstract is supported.
@@ -379,7 +480,100 @@ 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'
+
+# Example of fallback collection for suggestions import
+# suggestion:
+ # - collectionId: 8f7df5ca-f9c2-47a4-81ec-8a6393d6e5af
+ # source: "openaire"
+
+
+# Search settings
+search:
+ # Settings to enable/disable or configure advanced search filters.
+ advancedFilters:
+ enabled: false
+ # List of filters to enable in "Advanced Search" dropdown
+ filter: [ 'title', 'author', 'subject', 'entityType' ]
+ #
+ # 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
+
+
+# Notify metrics
+# Configuration for Notify Admin Dashboard for metrics visualization
+notifyMetrics:
+ # Configuration for received messages
+- title: 'admin-notify-dashboard.received-ldn'
+ boxes:
+ - color: '#B8DAFF'
+ title: 'admin-notify-dashboard.NOTIFY.incoming.accepted'
+ config: 'NOTIFY.incoming.accepted'
+ description: 'admin-notify-dashboard.NOTIFY.incoming.accepted.description'
+ - color: '#D4EDDA'
+ title: 'admin-notify-dashboard.NOTIFY.incoming.processed'
+ config: 'NOTIFY.incoming.processed'
+ description: 'admin-notify-dashboard.NOTIFY.incoming.processed.description'
+ - color: '#FDBBC7'
+ title: 'admin-notify-dashboard.NOTIFY.incoming.failure'
+ config: 'NOTIFY.incoming.failure'
+ description: 'admin-notify-dashboard.NOTIFY.incoming.failure.description'
+ - color: '#FDBBC7'
+ title: 'admin-notify-dashboard.NOTIFY.incoming.untrusted'
+ config: 'NOTIFY.incoming.untrusted'
+ description: 'admin-notify-dashboard.NOTIFY.incoming.untrusted.description'
+ - color: '#43515F'
+ title: 'admin-notify-dashboard.NOTIFY.incoming.involvedItems'
+ textColor: '#fff'
+ config: 'NOTIFY.incoming.involvedItems'
+ description: 'admin-notify-dashboard.NOTIFY.incoming.involvedItems.description'
+# Configuration for outgoing messages
+- title: 'admin-notify-dashboard.generated-ldn'
+ boxes:
+ - color: '#B8DAFF'
+ title: 'admin-notify-dashboard.NOTIFY.outgoing.queued'
+ config: 'NOTIFY.outgoing.queued'
+ description: 'admin-notify-dashboard.NOTIFY.outgoing.queued.description'
+ - color: '#FDEEBB'
+ title: 'admin-notify-dashboard.NOTIFY.outgoing.queued_for_retry'
+ config: 'NOTIFY.outgoing.queued_for_retry'
+ description: 'admin-notify-dashboard.NOTIFY.outgoing.queued_for_retry.description'
+ - color: '#FDBBC7'
+ title: 'admin-notify-dashboard.NOTIFY.outgoing.failure'
+ config: 'NOTIFY.outgoing.failure'
+ description: 'admin-notify-dashboard.NOTIFY.outgoing.failure.description'
+ - color: '#43515F'
+ title: 'admin-notify-dashboard.NOTIFY.outgoing.involvedItems'
+ textColor: '#fff'
+ config: 'NOTIFY.outgoing.involvedItems'
+ description: 'admin-notify-dashboard.NOTIFY.outgoing.involvedItems.description'
+ - color: '#D4EDDA'
+ title: 'admin-notify-dashboard.NOTIFY.outgoing.delivered'
+ config: 'NOTIFY.outgoing.delivered'
+ description: 'admin-notify-dashboard.NOTIFY.outgoing.delivered.description'
+
+
+# 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
+
+# Configuration for storing accessibility settings, used by the AccessibilitySettingsService
+accessibility:
+ # The duration in days after which the accessibility settings cookie expires
+ cookieExpirationDuration: 7
diff --git a/config/config.yml b/config/config.yml
index a5337cdd0d4..109db60ca92 100644
--- a/config/config.yml
+++ b/config/config.yml
@@ -1,5 +1,5 @@
rest:
- ssl: false
- host: localhost
- port: 8080
+ ssl: true
+ host: sandbox.dspace.org
+ port: 443
nameSpace: /server
diff --git a/cypress.config.ts b/cypress.config.ts
index 91eeb9838b3..36d8120342a 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 00000000000..332d44da138
--- /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 00000000000..e66f0ccaad8
--- /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 00000000000..8ba524d5be1
--- /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 00000000000..884db4ed33e
--- /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-batch-selector');
+ });
+});
diff --git a/cypress/e2e/admin-notifications-publication-claim-page.cy.ts b/cypress/e2e/admin-notifications-publication-claim-page.cy.ts
new file mode 100644
index 00000000000..877a0542e25
--- /dev/null
+++ b/cypress/e2e/admin-notifications-publication-claim-page.cy.ts
@@ -0,0 +1,17 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Admin Notifications Publication Claim Page', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/admin/notifications/publication-claim');
+ 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-notifications-publication-claim-page').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-admin-notifications-publication-claim-page');
+ });
+});
diff --git a/cypress/e2e/admin-search-page.cy.ts b/cypress/e2e/admin-search-page.cy.ts
new file mode 100644
index 00000000000..4fbf8939fe4
--- /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 00000000000..be1c9d4ef27
--- /dev/null
+++ b/cypress/e2e/admin-sidebar.cy.ts
@@ -0,0 +1,28 @@
+import { testA11y } from 'cypress/support/utils';
+import { Options } from 'cypress-axe';
+
+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 00000000000..c3c235e346d
--- /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 00000000000..871b8644ce1
--- /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 00000000000..f113d45ebce
--- /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 ea6acdafcde..f660f47a540 100644
--- a/cypress/e2e/breadcrumbs.cy.ts
+++ b/cypress/e2e/breadcrumbs.cy.ts
@@ -1,15 +1,14 @@
-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));
+ it('should pass accessibility tests', () => {
+ // Visit an Item, as those have more breadcrumbs
+ cy.visit('/entities/publication/'.concat(Cypress.env('DSPACE_TEST_ENTITY_PUBLICATION')));
- // Wait for breadcrumbs to be visible
- cy.get('ds-breadcrumbs').should('be.visible');
+ // Wait for breadcrumbs to be visible
+ cy.get('ds-breadcrumbs').should('be.visible');
- // Analyze for accessibility
- testA11y('ds-breadcrumbs');
- });
+ // Analyze for accessibility
+ testA11y('ds-breadcrumbs');
+ });
});
diff --git a/cypress/e2e/browse-by-author.cy.ts b/cypress/e2e/browse-by-author.cy.ts
index 07c20ad7c91..3e914a2f8c0 100644
--- a/cypress/e2e/browse-by-author.cy.ts
+++ b/cypress/e2e/browse-by-author.cy.ts
@@ -1,13 +1,13 @@
import { testA11y } from 'cypress/support/utils';
describe('Browse By Author', () => {
- it('should pass accessibility tests', () => {
- cy.visit('/browse/author');
+ it('should pass accessibility tests', () => {
+ cy.visit('/browse/author');
- // Wait for to be visible
- cy.get('ds-browse-by-metadata-page').should('be.visible');
+ // Wait for to be visible
+ cy.get('ds-browse-by-metadata').should('be.visible');
- // Analyze for accessibility
- testA11y('ds-browse-by-metadata-page');
- });
+ // Analyze for accessibility
+ testA11y('ds-browse-by-metadata');
+ });
});
diff --git a/cypress/e2e/browse-by-dateissued.cy.ts b/cypress/e2e/browse-by-dateissued.cy.ts
index 4d22420227c..5fe05433153 100644
--- a/cypress/e2e/browse-by-dateissued.cy.ts
+++ b/cypress/e2e/browse-by-dateissued.cy.ts
@@ -1,13 +1,13 @@
import { testA11y } from 'cypress/support/utils';
describe('Browse By Date Issued', () => {
- it('should pass accessibility tests', () => {
- cy.visit('/browse/dateissued');
+ it('should pass accessibility tests', () => {
+ cy.visit('/browse/dateissued');
- // Wait for to be visible
- cy.get('ds-browse-by-date-page').should('be.visible');
+ // Wait for to be visible
+ cy.get('ds-browse-by-date').should('be.visible');
- // Analyze for accessibility
- testA11y('ds-browse-by-date-page');
- });
+ // Analyze for accessibility
+ testA11y('ds-browse-by-date');
+ });
});
diff --git a/cypress/e2e/browse-by-subject.cy.ts b/cypress/e2e/browse-by-subject.cy.ts
index 89b791f03c4..0937a2542bb 100644
--- a/cypress/e2e/browse-by-subject.cy.ts
+++ b/cypress/e2e/browse-by-subject.cy.ts
@@ -1,13 +1,13 @@
import { testA11y } from 'cypress/support/utils';
describe('Browse By Subject', () => {
- it('should pass accessibility tests', () => {
- cy.visit('/browse/subject');
+ it('should pass accessibility tests', () => {
+ cy.visit('/browse/subject');
- // Wait for to be visible
- cy.get('ds-browse-by-metadata-page').should('be.visible');
+ // Wait for to be visible
+ cy.get('ds-browse-by-metadata').should('be.visible');
- // Analyze for accessibility
- testA11y('ds-browse-by-metadata-page');
- });
+ // Analyze for accessibility
+ testA11y('ds-browse-by-metadata');
+ });
});
diff --git a/cypress/e2e/browse-by-title.cy.ts b/cypress/e2e/browse-by-title.cy.ts
index e4e027586a8..71a7356ce32 100644
--- a/cypress/e2e/browse-by-title.cy.ts
+++ b/cypress/e2e/browse-by-title.cy.ts
@@ -1,13 +1,13 @@
import { testA11y } from 'cypress/support/utils';
describe('Browse By Title', () => {
- it('should pass accessibility tests', () => {
- cy.visit('/browse/title');
+ it('should pass accessibility tests', () => {
+ cy.visit('/browse/title');
- // Wait for to be visible
- cy.get('ds-browse-by-title-page').should('be.visible');
+ // Wait for to be visible
+ cy.get('ds-browse-by-title').should('be.visible');
- // Analyze for accessibility
- testA11y('ds-browse-by-title-page');
- });
+ // Analyze for accessibility
+ testA11y('ds-browse-by-title');
+ });
});
diff --git a/cypress/e2e/bulk-access.cy.ts b/cypress/e2e/bulk-access.cy.ts
new file mode 100644
index 00000000000..87033e13e4f
--- /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-create.cy.ts b/cypress/e2e/collection-create.cy.ts
new file mode 100644
index 00000000000..29f7dd5cacb
--- /dev/null
+++ b/cypress/e2e/collection-create.cy.ts
@@ -0,0 +1,13 @@
+beforeEach(() => {
+ cy.visit('/collections/create?parent='.concat(Cypress.env('DSPACE_TEST_COMMUNITY')));
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+});
+
+it('should show loading component while saving', () => {
+ const title = 'Test Collection Title';
+ cy.get('#title').type(title);
+
+ cy.get('button[type="submit"]').click();
+
+ cy.get('ds-loading').should('be.visible');
+});
diff --git a/cypress/e2e/collection-edit.cy.ts b/cypress/e2e/collection-edit.cy.ts
new file mode 100644
index 00000000000..e1ba1c5eed8
--- /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 a034b4361d6..d12536d332a 100644
--- a/cypress/e2e/collection-page.cy.ts
+++ b/cypress/e2e/collection-page.cy.ts
@@ -1,15 +1,14 @@
-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.visit('/collections/'.concat(Cypress.env('DSPACE_TEST_COLLECTION')));
- // tag must be loaded
- cy.get('ds-collection-page').should('be.visible');
+ // tag must be loaded
+ cy.get('ds-collection-page').should('be.visible');
- // Analyze for accessibility issues
- testA11y('ds-collection-page');
- });
+ // 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 6df4e9a4542..3e5a465e398 100644
--- a/cypress/e2e/collection-statistics.cy.ts
+++ b/cypress/e2e/collection-statistics.cy.ts
@@ -1,37 +1,37 @@
-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);
-
- 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.location('pathname').should('eq', COLLECTIONSTATISTICSPAGE);
- });
-
- it('should contain a "Total visits" section', () => {
- cy.visit(COLLECTIONSTATISTICSPAGE);
- cy.get('table[data-test="TotalVisits"]').should('be.visible');
- });
-
- 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');
- });
-
- it('should pass accessibility tests', () => {
- cy.visit(COLLECTIONSTATISTICSPAGE);
-
- // tag must be loaded
- cy.get('ds-collection-statistics-page').should('be.visible');
-
- // Verify / wait until "Total Visits" table's label is non-empty
- // (This table loads these labels asynchronously, so we want to wait for them before analyzing page)
- cy.get('table[data-test="TotalVisits"] th[data-test="statistics-label"]').contains(REGEX_MATCH_NON_EMPTY_TEXT);
-
- // Analyze for accessibility issues
- testA11y('ds-collection-statistics-page');
- });
+ 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(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);
+ });
+
+ it('should contain a "Total visits" section', () => {
+ cy.visit(COLLECTIONSTATISTICSPAGE);
+ cy.get('table[data-test="TotalVisits"]').should('be.visible');
+ });
+
+ 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(Cypress.env('DSPACE_TEST_COLLECTION')).concat('_TotalVisitsPerMonth')).should('exist');
+ });
+
+ it('should pass accessibility tests', () => {
+ cy.visit(COLLECTIONSTATISTICSPAGE);
+
+ // tag must be loaded
+ cy.get('ds-collection-statistics-page').should('be.visible');
+
+ // Verify / wait until "Total Visits" table's label is non-empty
+ // (This table loads these labels asynchronously, so we want to wait for them before analyzing page)
+ cy.get('table[data-test="TotalVisits"] th[data-test="statistics-label"]').contains(REGEX_MATCH_NON_EMPTY_TEXT);
+
+ // Analyze for accessibility issues
+ testA11y('ds-collection-statistics-page');
+ });
});
diff --git a/cypress/e2e/community-create.cy.ts b/cypress/e2e/community-create.cy.ts
new file mode 100644
index 00000000000..96bc003ba2a
--- /dev/null
+++ b/cypress/e2e/community-create.cy.ts
@@ -0,0 +1,13 @@
+beforeEach(() => {
+ cy.visit('/communities/create');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+});
+
+it('should show loading component while saving', () => {
+ const title = 'Test Community Title';
+ cy.get('#title').type(title);
+
+ cy.get('button[type="submit"]').click();
+
+ cy.get('ds-loading').should('be.visible');
+});
diff --git a/cypress/e2e/community-edit.cy.ts b/cypress/e2e/community-edit.cy.ts
new file mode 100644
index 00000000000..77e260feec0
--- /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 c371f6ceae7..9b9c87b112d 100644
--- a/cypress/e2e/community-list.cy.ts
+++ b/cypress/e2e/community-list.cy.ts
@@ -2,16 +2,16 @@ import { testA11y } from 'cypress/support/utils';
describe('Community List Page', () => {
- it('should pass accessibility tests', () => {
- cy.visit('/community-list');
+ it('should pass accessibility tests', () => {
+ cy.visit('/community-list');
- // tag must be loaded
- cy.get('ds-community-list-page').should('be.visible');
+ // tag must be loaded
+ cy.get('ds-community-list-page').should('be.visible');
- // Open every expand button on page, so that we can scan sub-elements as well
- cy.get('[data-test="expand-button"]').click({ multiple: true });
+ // Open every expand button on page, so that we can scan sub-elements as well
+ cy.get('[data-test="expand-button"]').click({ multiple: true });
- // Analyze for accessibility issues
- testA11y('ds-community-list-page');
- });
+ // Analyze for accessibility issues
+ testA11y('ds-community-list-page');
+ });
});
diff --git a/cypress/e2e/community-page.cy.ts b/cypress/e2e/community-page.cy.ts
index 6c628e21ce1..5a4441dbae8 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));
+ it('should pass accessibility tests', () => {
+ cy.visit('/communities/'.concat(Cypress.env('DSPACE_TEST_COMMUNITY')));
- // tag must be loaded
- cy.get('ds-community-page').should('be.visible');
+ // tag must be loaded
+ cy.get('ds-community-page').should('be.visible');
- // Analyze for accessibility issues
- testA11y('ds-community-page',);
- });
+ // Analyze for accessibility issues
+ testA11y('ds-community-page');
+ });
});
diff --git a/cypress/e2e/community-statistics.cy.ts b/cypress/e2e/community-statistics.cy.ts
index 710450e7972..00e23a90b37 100644
--- a/cypress/e2e/community-statistics.cy.ts
+++ b/cypress/e2e/community-statistics.cy.ts
@@ -1,37 +1,37 @@
-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);
-
- 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.location('pathname').should('eq', COMMUNITYSTATISTICSPAGE);
- });
-
- it('should contain a "Total visits" section', () => {
- cy.visit(COMMUNITYSTATISTICSPAGE);
- cy.get('table[data-test="TotalVisits"]').should('be.visible');
- });
-
- 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');
- });
-
- it('should pass accessibility tests', () => {
- cy.visit(COMMUNITYSTATISTICSPAGE);
-
- // tag must be loaded
- cy.get('ds-community-statistics-page').should('be.visible');
-
- // Verify / wait until "Total Visits" table's label is non-empty
- // (This table loads these labels asynchronously, so we want to wait for them before analyzing page)
- cy.get('table[data-test="TotalVisits"] th[data-test="statistics-label"]').contains(REGEX_MATCH_NON_EMPTY_TEXT);
-
- // Analyze for accessibility issues
- testA11y('ds-community-statistics-page');
- });
+ 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(Cypress.env('DSPACE_TEST_COMMUNITY')));
+ cy.get('ds-navbar ds-link-menu-item a[data-test="link-menu-item.menu.section.statistics"]').click();
+ cy.location('pathname').should('eq', COMMUNITYSTATISTICSPAGE);
+ });
+
+ it('should contain a "Total visits" section', () => {
+ cy.visit(COMMUNITYSTATISTICSPAGE);
+ cy.get('table[data-test="TotalVisits"]').should('be.visible');
+ });
+
+ 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(Cypress.env('DSPACE_TEST_COMMUNITY')).concat('_TotalVisitsPerMonth')).should('exist');
+ });
+
+ it('should pass accessibility tests', () => {
+ cy.visit(COMMUNITYSTATISTICSPAGE);
+
+ // tag must be loaded
+ cy.get('ds-community-statistics-page').should('be.visible');
+
+ // Verify / wait until "Total Visits" table's label is non-empty
+ // (This table loads these labels asynchronously, so we want to wait for them before analyzing page)
+ cy.get('table[data-test="TotalVisits"] th[data-test="statistics-label"]').contains(REGEX_MATCH_NON_EMPTY_TEXT);
+
+ // Analyze for accessibility issues
+ testA11y('ds-community-statistics-page');
+ });
});
diff --git a/cypress/e2e/create-eperson.cy.ts b/cypress/e2e/create-eperson.cy.ts
new file mode 100644
index 00000000000..d23986ba29d
--- /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 00000000000..135c041a8d5
--- /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 00000000000..166c913b8c8
--- /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 00000000000..e43ede978ad
--- /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 00000000000..989d21ce60f
--- /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 00000000000..a6192f13d95
--- /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 00000000000..75fe1097c63
--- /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/footer.cy.ts b/cypress/e2e/footer.cy.ts
index 656e9d47012..4ee1d6669ae 100644
--- a/cypress/e2e/footer.cy.ts
+++ b/cypress/e2e/footer.cy.ts
@@ -1,13 +1,13 @@
import { testA11y } from 'cypress/support/utils';
describe('Footer', () => {
- it('should pass accessibility tests', () => {
- cy.visit('/');
+ it('should pass accessibility tests', () => {
+ cy.visit('/');
- // Footer must first be visible
- cy.get('ds-footer').should('be.visible');
+ // Footer must first be visible
+ cy.get('ds-footer').should('be.visible');
- // Analyze for accessibility
- testA11y('ds-footer');
- });
+ // Analyze for accessibility
+ testA11y('ds-footer');
+ });
});
diff --git a/cypress/e2e/groups-registry.cy.ts b/cypress/e2e/groups-registry.cy.ts
new file mode 100644
index 00000000000..5c0099c2f1f
--- /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 1a9b841eb7d..aa65aee570e 100644
--- a/cypress/e2e/header.cy.ts
+++ b/cypress/e2e/header.cy.ts
@@ -1,18 +1,38 @@
import { testA11y } from 'cypress/support/utils';
describe('Header', () => {
- it('should pass accessibility tests', () => {
- cy.visit('/');
-
- // Header must first be visible
- 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
- ],
- });
- });
+ it('should pass accessibility tests', () => {
+ cy.visit('/');
+
+ // Header must first be visible
+ cy.get('ds-header').should('be.visible');
+
+ // Analyze for accessibility
+ testA11y('ds-header');
+ });
+
+ it('should allow for changing language to German (for example)', () => {
+ cy.visit('/');
+
+ // Click the language switcher (globe) in header
+ cy.get('button[data-test="lang-switch"]').click();
+ // Click on the "Deusch" language in dropdown
+ cy.get('#language-menu-list div[role="option"]').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('[data-test="login-menu"]').contains('Anmelden');
+
+ // Change back to English from language switcher
+ cy.get('button[data-test="lang-switch"]').click();
+ cy.get('#language-menu-list div[role="option"]').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('[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 00000000000..c702fa72d79
--- /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 2a1ab9785ab..f9642c0c831 100644
--- a/cypress/e2e/homepage-statistics.cy.ts
+++ b/cypress/e2e/homepage-statistics.cy.ts
@@ -1,31 +1,32 @@
-import { REGEX_MATCH_NON_EMPTY_TEXT, TEST_ENTITY_PUBLICATION } from 'cypress/support/e2e';
-import { testA11y } from 'cypress/support/utils';
import '../support/commands';
+import { REGEX_MATCH_NON_EMPTY_TEXT } from 'cypress/support/e2e';
+import { testA11y } from 'cypress/support/utils';
+
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.location('pathname').should('eq', '/statistics');
- });
+ it('should load if you click on "Statistics" from homepage', () => {
+ cy.visit('/');
+ cy.get('ds-navbar ds-link-menu-item 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');
+ it('should pass accessibility tests', () => {
+ // generate 2 view events on an Item's page
+ cy.generateViewEvent(Cypress.env('DSPACE_TEST_ENTITY_PUBLICATION'), 'item');
+ cy.generateViewEvent(Cypress.env('DSPACE_TEST_ENTITY_PUBLICATION'), 'item');
- cy.visit('/statistics');
+ cy.visit('/statistics');
- // tag must be visable
- cy.get('ds-site-statistics-page').should('be.visible');
+ // tag must be visable
+ cy.get('ds-site-statistics-page').should('be.visible');
- // Verify / wait until "Total Visits" table's *last* label is non-empty
- // (This table loads these labels asynchronously, so we want to wait for them before analyzing page)
- cy.get('table[data-test="TotalVisits"] th[data-test="statistics-label"]').last().contains(REGEX_MATCH_NON_EMPTY_TEXT);
- // Wait an extra 500ms, just so all entries in Total Visits have loaded.
- cy.wait(500);
+ // Verify / wait until "Total Visits" table's *last* label is non-empty
+ // (This table loads these labels asynchronously, so we want to wait for them before analyzing page)
+ cy.get('table[data-test="TotalVisits"] th[data-test="statistics-label"]').last().contains(REGEX_MATCH_NON_EMPTY_TEXT);
+ // Wait an extra 500ms, just so all entries in Total Visits have loaded.
+ cy.wait(500);
- // Analyze for accessibility issues
- testA11y('ds-site-statistics-page');
- });
+ // Analyze for accessibility issues
+ testA11y('ds-site-statistics-page');
+ });
});
diff --git a/cypress/e2e/item-edit.cy.ts b/cypress/e2e/item-edit.cy.ts
new file mode 100644
index 00000000000..ad5d8ea0930
--- /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 9dba6eb8cea..b79b6ac31d1 100644
--- a/cypress/e2e/item-page.cy.ts
+++ b/cypress/e2e/item-page.cy.ts
@@ -1,33 +1,32 @@
-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.location('pathname').should('eq', ENTITYPAGE);
- });
+ // 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.location('pathname').should('eq', ENTITYPAGE);
+ });
- it('should pass accessibility tests', () => {
- cy.visit(ENTITYPAGE);
+ it('should pass accessibility tests', () => {
+ cy.visit(ENTITYPAGE);
- // tag must be loaded
- cy.get('ds-item-page').should('be.visible');
+ // tag must be loaded
+ cy.get('ds-item-page').should('be.visible');
- // Analyze for accessibility issues
- testA11y('ds-item-page');
- });
+ // Analyze for accessibility issues
+ testA11y('ds-item-page');
+ });
- it('should pass accessibility tests on full item page', () => {
- cy.visit(ENTITYPAGE + '/full');
+ it('should pass accessibility tests on full item page', () => {
+ cy.visit(ENTITYPAGE + '/full');
- // tag must be loaded
- cy.get('ds-full-item-page').should('be.visible');
+ // tag must be loaded
+ cy.get('ds-full-item-page').should('be.visible');
- // Analyze for accessibility issues
- testA11y('ds-full-item-page');
- });
+ // 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 9b90cb24afc..6518f595a90 100644
--- a/cypress/e2e/item-statistics.cy.ts
+++ b/cypress/e2e/item-statistics.cy.ts
@@ -1,43 +1,43 @@
-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);
-
- 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.location('pathname').should('eq', ITEMSTATISTICSPAGE);
- });
-
- it('should contain element ds-item-statistics-page when navigating to an item statistics page', () => {
- cy.visit(ITEMSTATISTICSPAGE);
- cy.get('ds-item-statistics-page').should('be.visible');
- cy.get('ds-item-page').should('not.exist');
- });
-
- it('should contain a "Total visits" section', () => {
- cy.visit(ITEMSTATISTICSPAGE);
- cy.get('table[data-test="TotalVisits"]').should('be.visible');
- });
-
- 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');
- });
-
- it('should pass accessibility tests', () => {
- cy.visit(ITEMSTATISTICSPAGE);
-
- // tag must be loaded
- cy.get('ds-item-statistics-page').should('be.visible');
-
- // Verify / wait until "Total Visits" table's label is non-empty
- // (This table loads these labels asynchronously, so we want to wait for them before analyzing page)
- cy.get('table[data-test="TotalVisits"] th[data-test="statistics-label"]').contains(REGEX_MATCH_NON_EMPTY_TEXT);
-
- // Analyze for accessibility issues
- testA11y('ds-item-statistics-page');
- });
+ 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(Cypress.env('DSPACE_TEST_ENTITY_PUBLICATION')));
+ cy.get('ds-navbar ds-link-menu-item a[data-test="link-menu-item.menu.section.statistics"]').click();
+ cy.location('pathname').should('eq', ITEMSTATISTICSPAGE);
+ });
+
+ it('should contain element ds-item-statistics-page when navigating to an item statistics page', () => {
+ cy.visit(ITEMSTATISTICSPAGE);
+ cy.get('ds-item-statistics-page').should('be.visible');
+ cy.get('ds-item-page').should('not.exist');
+ });
+
+ it('should contain a "Total visits" section', () => {
+ cy.visit(ITEMSTATISTICSPAGE);
+ cy.get('table[data-test="TotalVisits"]').should('be.visible');
+ });
+
+ 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(Cypress.env('DSPACE_TEST_ENTITY_PUBLICATION')).concat('_TotalVisitsPerMonth')).should('exist');
+ });
+
+ it('should pass accessibility tests', () => {
+ cy.visit(ITEMSTATISTICSPAGE);
+
+ // tag must be loaded
+ cy.get('ds-item-statistics-page').should('be.visible');
+
+ // Verify / wait until "Total Visits" table's label is non-empty
+ // (This table loads these labels asynchronously, so we want to wait for them before analyzing page)
+ cy.get('table[data-test="TotalVisits"] th[data-test="statistics-label"]').contains(REGEX_MATCH_NON_EMPTY_TEXT);
+
+ // Analyze for accessibility issues
+ testA11y('ds-item-statistics-page');
+ });
});
diff --git a/cypress/e2e/item-template.cy.ts b/cypress/e2e/item-template.cy.ts
new file mode 100644
index 00000000000..5f5b21a16ab
--- /dev/null
+++ b/cypress/e2e/item-template.cy.ts
@@ -0,0 +1,15 @@
+const ADD_TEMPLATE_ITEM_PAGE = '/collections/'.concat(Cypress.env('DSPACE_TEST_COLLECTION')).concat('/itemtemplate');
+
+describe('Item Template', () => {
+ beforeEach(() => {
+ cy.visit(ADD_TEMPLATE_ITEM_PAGE);
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should load properly', () => {
+ cy.contains('.ds-header-row .lbl-cell', 'Field', { timeout: 10000 }).should('exist').should('be.visible');
+ cy.contains('.ds-header-row b', 'Value', { timeout: 10000 }).should('exist').should('be.visible');
+ cy.contains('.ds-header-row b', 'Lang', { timeout: 10000 }).should('exist').should('be.visible');
+ cy.contains('.ds-header-row b', 'Edit', { timeout: 10000 }).should('exist').should('be.visible');
+ });
+});
diff --git a/cypress/e2e/login-modal.cy.ts b/cypress/e2e/login-modal.cy.ts
index d29c13c2f96..1d72306accd 100644
--- a/cypress/e2e/login-modal.cy.ts
+++ b/cypress/e2e/login-modal.cy.ts
@@ -1,138 +1,150 @@
-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);
- cy.visit(ENTITYPAGE);
+ it('should login when clicking button & stay on same page', () => {
+ const ENTITYPAGE = '/entities/publication/'.concat(Cypress.env('DSPACE_TEST_ENTITY_PUBLICATION'));
+ cy.visit(ENTITYPAGE);
- // Login menu should exist
- cy.get('ds-log-in').should('exist');
+ // Login menu should exist
+ cy.get('ds-log-in').should('exist');
- // Login, and the tag should no longer exist
- page.openLoginMenu();
- cy.get('.form-login').should('be.visible');
+ // Login, and the tag should no longer exist
+ page.openLoginMenu();
+ cy.get('.form-login').should('be.visible');
- page.submitLoginAndPasswordByPressingButton(TEST_ADMIN_USER, TEST_ADMIN_PASSWORD);
- cy.get('ds-log-in').should('not.exist');
+ 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
- cy.url().should('include', ENTITYPAGE);
+ // Verify we are still on the same page
+ cy.url().should('include', ENTITYPAGE);
- // Open user menu, verify user menu & logout button now available
- page.openUserMenu();
- cy.get('ds-user-menu').should('be.visible');
- cy.get('ds-log-out').should('be.visible');
- });
+ // Open user menu, verify user menu & logout button now available
+ page.openUserMenu();
+ cy.get('ds-user-menu').should('be.visible');
+ cy.get('ds-log-out').should('be.visible');
+ });
- it('should login when clicking enter key & stay on same page', () => {
- cy.visit('/home');
+ it('should login when clicking enter key & stay on same page', () => {
+ cy.visit('/home');
- // Open login menu in header & verify tag is visible
- page.openLoginMenu();
- cy.get('.form-login').should('be.visible');
+ // Open login menu in header & verify tag is visible
+ page.openLoginMenu();
+ 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');
+ // Login, and the tag should no longer 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');
+ // Verify we are still on homepage
+ cy.url().should('include', '/home');
- // Open user menu, verify user menu & logout button now available
- page.openUserMenu();
- cy.get('ds-user-menu').should('be.visible');
- cy.get('ds-log-out').should('be.visible');
- });
+ // Open user menu, verify user menu & logout button now available
+ page.openUserMenu();
+ cy.get('ds-user-menu').should('be.visible');
+ cy.get('ds-log-out').should('be.visible');
+ });
- it('should support logout', () => {
- // First authenticate & access homepage
- cy.login(TEST_ADMIN_USER, TEST_ADMIN_PASSWORD);
- cy.visit('/');
+ it('should support logout', () => {
+ // First authenticate & access homepage
+ 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
- cy.get('ds-log-in').should('not.exist');
- cy.get('ds-log-out').should('exist');
+ // Verify ds-log-in tag doesn't exist, but ds-log-out tag does exist
+ cy.get('ds-log-in').should('not.exist');
+ cy.get('ds-log-out').should('exist');
- // Click logout button
- page.openUserMenu();
- page.submitLogoutByPressingButton();
+ // Click logout button
+ page.openUserMenu();
+ page.submitLogoutByPressingButton();
- // Verify ds-log-in tag now exists
- cy.get('ds-log-in').should('exist');
- cy.get('ds-log-out').should('not.exist');
- });
+ // Verify ds-log-in tag now exists
+ cy.get('ds-log-in').should('exist');
+ cy.get('ds-log-out').should('not.exist');
+ });
- it('should allow new user registration', () => {
- cy.visit('/');
+ it('should allow new user registration', () => {
+ cy.visit('/');
- page.openLoginMenu();
+ page.openLoginMenu();
- // Registration link should be visible
- cy.get('ds-themed-navbar [data-test="register"]').should('be.visible');
+ // Registration link should be visible
+ cy.get('ds-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.location('pathname').should('eq', '/register');
- cy.get('ds-register-email').should('exist');
- });
+ // Click registration link & you should go to registration page
+ cy.get('ds-header [data-test="register"]').click();
+ cy.location('pathname').should('eq', '/register');
+ cy.get('ds-register-email').should('exist');
- it('should allow forgot password', () => {
- cy.visit('/');
+ // Test accessibility of this page
+ testA11y('ds-register-email');
+ });
- page.openLoginMenu();
+ it('should allow forgot password', () => {
+ cy.visit('/');
- // Forgot password link should be visible
- cy.get('ds-themed-navbar [data-test="forgot"]').should('be.visible');
+ page.openLoginMenu();
- // Click link & you should go to Forgot Password page
- cy.get('ds-themed-navbar [data-test="forgot"]').click();
- cy.location('pathname').should('eq', '/forgot');
- cy.get('ds-forgot-email').should('exist');
- });
+ // Forgot password link should be visible
+ cy.get('ds-header [data-test="forgot"]').should('be.visible');
- it('should pass accessibility tests', () => {
- cy.visit('/');
+ // Click link & you should go to Forgot Password page
+ cy.get('ds-header [data-test="forgot"]').click();
+ cy.location('pathname').should('eq', '/forgot');
+ cy.get('ds-forgot-email').should('exist');
- page.openLoginMenu();
+ // Test accessibility of this page
+ testA11y('ds-forgot-email');
+ });
- cy.get('ds-log-in').should('exist');
+ it('should pass accessibility tests in menus', () => {
+ cy.visit('/');
- // Analyze for accessibility issues
- testA11y('ds-log-in');
- });
+ // 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 00000000000..a31c18e4ebb
--- /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 00000000000..0402d33153e
--- /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 00000000000..9ff0db0714b
--- /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 13f4a1b5471..159bb4f5e65 100644
--- a/cypress/e2e/my-dspace.cy.ts
+++ b/cypress/e2e/my-dspace.cy.ts
@@ -1,141 +1,134 @@
-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', () => {
- it('should display recent submissions and pass accessibility tests', () => {
- cy.visit('/mydspace');
+ it('should display recent submissions and pass 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);
+ // This page is restricted, so we will be shown the login form. Fill it out & submit.
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_SUBMIT_USER'), Cypress.env('DSPACE_TEST_SUBMIT_USER_PASSWORD'));
- cy.get('ds-my-dspace-page').should('be.visible');
+ cy.get('ds-my-dspace-page').should('be.visible');
- // At least one recent submission should be displayed
- cy.get('[data-test="list-object"]').should('be.visible');
+ // At least one recent submission 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('.filter-toggle').click({ multiple: true });
+ // Click each filter toggle to open *every* filter
+ // (As we want to scan filter section for accessibility issues as well)
+ cy.get('.filter-toggle').click({ multiple: true });
- // Analyze for accessibility issues
- testA11y('ds-my-dspace-page');
- });
+ // Analyze for accessibility issues
+ testA11y('ds-my-dspace-page');
+ });
- it('should have a working detailed view that passes accessibility tests', () => {
- cy.visit('/mydspace');
+ 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);
+ // This page is restricted, so we will be shown the login form. Fill it out & submit.
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_SUBMIT_USER'), Cypress.env('DSPACE_TEST_SUBMIT_USER_PASSWORD'));
- cy.get('ds-my-dspace-page').should('be.visible');
+ cy.get('ds-my-dspace-page').should('be.visible');
- // Click button in sidebar to display detailed view
- cy.get('ds-search-sidebar [data-test="detail-view"]').click();
+ // Click button in sidebar to display detailed view
+ cy.get('ds-search-sidebar [data-test="detail-view"]').click();
- cy.get('ds-object-detail').should('be.visible');
+ 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
- it('should let you start a new submission & edit in-progress submissions', () => {
- cy.visit('/mydspace');
+ // NOTE: Deleting existing submissions is exercised by submission.spec.ts
+ it('should let you start a new submission & edit in-progress submissions', () => {
+ 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);
+ // This page is restricted, so we will be shown the login form. Fill it out & submit.
+ 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();
- // Click on the "Item" type in that dropdown
- cy.get('#entityControlsDropdownMenu button[title="none"]').click();
+ // Open the New Submission dropdown
+ cy.get('button[data-test="submission-dropdown"]').click();
+ // Click on the "Item" type in that dropdown
+ cy.get('#entityControlsDropdownMenu button[title="none"]').click();
- // This should display the (popup window)
- cy.get('ds-create-item-parent-selector').should('be.visible');
+ // 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(TEST_SUBMIT_COLLECTION_NAME);
+ // 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_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();
+ // Click on the button matching that known Collection name
+ 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');
+ // 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');
+ // 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', TEST_SUBMIT_COLLECTION_NAME);
+ // 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_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
- cy.location().then(fullUrl => {
- // This will be the full path (/workspaceitems/[id]/edit)
- const path = fullUrl.pathname;
- // Split on the slashes
- const subpaths = path.split('/');
- // Part 2 will be the [id] of the submission
- const id = subpaths[2];
+ // 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
+ cy.location().then(fullUrl => {
+ // This will be the full path (/workspaceitems/[id]/edit)
+ const path = fullUrl.pathname;
+ // Split on the slashes
+ const subpaths = path.split('/');
+ // Part 2 will be the [id] of the submission
+ const id = subpaths[2];
- // Click the "Save for Later" button to save this submission
- cy.get('ds-submission-form-footer [data-test="save-for-later"]').click();
+ // Click the "Save for Later" button to save this submission
+ cy.get('ds-submission-form-footer [data-test="save-for-later"]').click();
- // "Save for Later" should send us to MyDSpace
- cy.url().should('include', '/mydspace');
+ // "Save for Later" should send us to MyDSpace
+ cy.url().should('include', '/mydspace');
- // Close any open notifications, to make sure they don't get in the way of next steps
- cy.get('[data-dismiss="alert"]').click({multiple: true});
+ // Close any open notifications, to make sure they don't get in the way of next steps
+ cy.get('[data-dismiss="alert"]').click({ multiple: true });
- // This is the GET command that will actually run the search
- cy.intercept('GET', '/server/api/discover/search/objects*').as('search-results');
- // On MyDSpace, find the submission we just created via its ID
- cy.get('[data-test="search-box"]').type(id);
- cy.get('[data-test="search-button"]').click();
+ // This is the GET command that will actually run the search
+ cy.intercept('GET', '/server/api/discover/search/objects*').as('search-results');
+ // On MyDSpace, find the submission we just created via its ID
+ cy.get('[data-test="search-box"]').type(id);
+ cy.get('[data-test="search-button"]').click();
- // Wait for search results to come back from the above GET command
- cy.wait('@search-results');
+ // Wait for search results to come back from the above GET command
+ cy.wait('@search-results');
- // Click the Edit button for this in-progress submission
- cy.get('#edit_' + id).click();
+ // Click the Edit button for this in-progress submission
+ cy.get('#edit_' + id).click();
- // Should send us back to the submission form
- cy.url().should('include', '/workspaceitems/' + id + '/edit');
+ // Should send us back to the submission form
+ cy.url().should('include', '/workspaceitems/' + id + '/edit');
- // Discard our new submission by clicking Discard in Submission form & confirming
- cy.get('ds-submission-form-footer [data-test="discard"]').click();
- cy.get('button#discard_submit').click();
+ // Discard our new submission by clicking Discard in Submission form & confirming
+ cy.get('ds-submission-form-footer [data-test="discard"]').click();
+ cy.get('button#discard_submit').click();
- // Discarding should send us back to MyDSpace
- cy.url().should('include', '/mydspace');
- });
+ // Discarding should send us back to MyDSpace
+ cy.url().should('include', '/mydspace');
});
+ });
- it('should let you import from external sources', () => {
- cy.visit('/mydspace');
+ it('should let you import from external sources', () => {
+ 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);
+ // This page is restricted, so we will be shown the login form. Fill it out & submit.
+ 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();
- // Click on the "Item" type in that dropdown
- cy.get('#importControlsDropdownMenu button[title="none"]').click();
+ // Open the New Import dropdown
+ cy.get('button[data-test="import-dropdown"]').click();
+ // Click on the "Item" type in that dropdown
+ cy.get('#importControlsDropdownMenu button[title="none"]').click();
- // New URL should include /import-external, as we've moved to the import page
- cy.url().should('include', '/import-external');
+ // New URL should include /import-external, as we've moved to the import page
+ cy.url().should('include', '/import-external');
- // The external import searchbox should be visible
- cy.get('ds-submission-import-external-searchbar').should('be.visible');
- });
+ // 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 00000000000..d26da7cc4df
--- /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 d02aa8541c3..968ae2747b5 100644
--- a/cypress/e2e/pagenotfound.cy.ts
+++ b/cypress/e2e/pagenotfound.cy.ts
@@ -1,18 +1,18 @@
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');
+ 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');
- });
+ // Analyze for accessibility issues
+ testA11y('ds-pagenotfound');
+ });
- it('should not contain element ds-pagenotfound when navigating to existing page', () => {
- cy.visit('/home');
- cy.get('ds-pagenotfound').should('not.exist');
- });
+ it('should not contain element ds-pagenotfound when navigating to existing page', () => {
+ cy.visit('/home');
+ cy.get('ds-pagenotfound').should('not.exist');
+ });
});
diff --git a/cypress/e2e/privacy.cy.ts b/cypress/e2e/privacy.cy.ts
new file mode 100644
index 00000000000..16e049f701e
--- /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 00000000000..2be3bd4c181
--- /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 00000000000..911ef33ba58
--- /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/quality-assurance-source-page.cy.ts b/cypress/e2e/quality-assurance-source-page.cy.ts
new file mode 100644
index 00000000000..722917ef16b
--- /dev/null
+++ b/cypress/e2e/quality-assurance-source-page.cy.ts
@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Quality Assurance Source Page', () => {
+ beforeEach(() => {
+ // Must login as an Admin to see the page
+ cy.visit('/notifications/quality-assurance');
+ cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+ });
+
+ it('should pass accessibility tests', () => {
+ // Source page must first be visible
+ cy.get('ds-quality-assurance-source-page-component').should('be.visible');
+ // Analyze for accessibility issues
+ testA11y('ds-quality-assurance-source-page-component');
+ });
+});
diff --git a/cypress/e2e/search-navbar.cy.ts b/cypress/e2e/search-navbar.cy.ts
index 648db17fe65..0613e5e7124 100644
--- a/cypress/e2e/search-navbar.cy.ts
+++ b/cypress/e2e/search-navbar.cy.ts
@@ -1,66 +1,64 @@
-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();
- // Fill out a query in input that appears
- cy.get('ds-themed-navbar [data-test="header-search-box"]').type(query);
- },
- submitQueryByPressingEnter() {
- cy.get('ds-themed-navbar [data-test="header-search-box"]').type('{enter}');
- },
- submitQueryByPressingIcon() {
- cy.get('ds-themed-navbar [data-test="header-search-icon"]').click();
- }
+ fillOutQueryInNavBar(query) {
+ // Click the magnifying glass
+ cy.get('ds-header [data-test="header-search-icon"]').click();
+ // Fill out a query in input that appears
+ cy.get('ds-header [data-test="header-search-box"]').type(query);
+ },
+ submitQueryByPressingEnter() {
+ cy.get('ds-header [data-test="header-search-box"]').type('{enter}');
+ },
+ submitQueryByPressingIcon() {
+ cy.get('ds-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;
+ // NOTE: these tests currently assume this query will return results!
+ const query = Cypress.env('DSPACE_TEST_SEARCH_TERM');
- it('should go to search page with correct query if submitted (from home)', () => {
- cy.visit('/');
- // This is the GET command that will actually run the search
- cy.intercept('GET', '/server/api/discover/search/objects*').as('search-results');
- // Run the search
- page.fillOutQueryInNavBar(query);
- page.submitQueryByPressingEnter();
- // New URL should include query param
- cy.url().should('include', 'query='.concat(query));
- // Wait for search results to come back from the above GET command
- cy.wait('@search-results');
- // At least one search result should be displayed
- cy.get('[data-test="list-object"]').should('be.visible');
- });
+ it('should go to search page with correct query if submitted (from home)', () => {
+ cy.visit('/');
+ // This is the GET command that will actually run the search
+ cy.intercept('GET', '/server/api/discover/search/objects*').as('search-results');
+ // Run the search
+ page.fillOutQueryInNavBar(query);
+ page.submitQueryByPressingEnter();
+ // New URL should include query param
+ cy.url().should('include', 'query='.concat(query));
+ // Wait for search results to come back from the above GET command
+ cy.wait('@search-results');
+ // At least one search result should be displayed
+ cy.get('[data-test="list-object"]').should('be.visible');
+ });
- it('should go to search page with correct query if submitted (from search)', () => {
- cy.visit('/search');
- // This is the GET command that will actually run the search
- cy.intercept('GET', '/server/api/discover/search/objects*').as('search-results');
- // Run the search
- page.fillOutQueryInNavBar(query);
- page.submitQueryByPressingEnter();
- // New URL should include query param
- cy.url().should('include', 'query='.concat(query));
- // Wait for search results to come back from the above GET command
- cy.wait('@search-results');
- // At least one search result should be displayed
- cy.get('[data-test="list-object"]').should('be.visible');
- });
+ it('should go to search page with correct query if submitted (from search)', () => {
+ cy.visit('/search');
+ // This is the GET command that will actually run the search
+ cy.intercept('GET', '/server/api/discover/search/objects*').as('search-results');
+ // Run the search
+ page.fillOutQueryInNavBar(query);
+ page.submitQueryByPressingEnter();
+ // New URL should include query param
+ cy.url().should('include', 'query='.concat(query));
+ // Wait for search results to come back from the above GET command
+ cy.wait('@search-results');
+ // At least one search result should be displayed
+ cy.get('[data-test="list-object"]').should('be.visible');
+ });
- it('should allow user to also submit query by clicking icon', () => {
- cy.visit('/');
- // This is the GET command that will actually run the search
- cy.intercept('GET', '/server/api/discover/search/objects*').as('search-results');
- // Run the search
- page.fillOutQueryInNavBar(query);
- page.submitQueryByPressingIcon();
- // New URL should include query param
- cy.url().should('include', 'query='.concat(query));
- // Wait for search results to come back from the above GET command
- cy.wait('@search-results');
- // At least one search result should be displayed
- cy.get('[data-test="list-object"]').should('be.visible');
- });
+ it('should allow user to also submit query by clicking icon', () => {
+ cy.visit('/');
+ // This is the GET command that will actually run the search
+ cy.intercept('GET', '/server/api/discover/search/objects*').as('search-results');
+ // Run the search
+ page.fillOutQueryInNavBar(query);
+ page.submitQueryByPressingIcon();
+ // New URL should include query param
+ cy.url().should('include', 'query='.concat(query));
+ // Wait for search results to come back from the above GET command
+ cy.wait('@search-results');
+ // At least one search result should be displayed
+ cy.get('[data-test="list-object"]').should('be.visible');
+ });
});
diff --git a/cypress/e2e/search-page.cy.ts b/cypress/e2e/search-page.cy.ts
index 755f8eaac6c..62e73c38772 100644
--- a/cypress/e2e/search-page.cy.ts
+++ b/cypress/e2e/search-page.cy.ts
@@ -1,56 +1,57 @@
-import { Options } from 'cypress-axe';
-import { TEST_SEARCH_TERM } from 'cypress/support/e2e';
import { testA11y } from 'cypress/support/utils';
+import { Options } from 'cypress-axe';
describe('Search Page', () => {
- 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');
- // Type query in searchbox & click search button
- cy.get('[data-test="search-box"]').type(queryString);
- cy.get('[data-test="search-button"]').click();
- cy.url().should('include', 'query=' + encodeURI(queryString));
- });
+ // 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');
+ // Type query in searchbox & click search button
+ cy.get('[data-test="search-box"]').type(queryString);
+ cy.get('[data-test="search-button"]').click();
+ cy.url().should('include', 'query=' + encodeURI(queryString));
+ });
- 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);
+ it('should load results and pass accessibility tests', () => {
+ 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');
+ // tag must be loaded
+ cy.get('ds-search-page').should('be.visible');
- // At least one search result should be displayed
- cy.get('[data-test="list-object"]').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 });
+ // 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-search-page');
- });
+ // Analyze for accessibility issues
+ testA11y('ds-search-page');
+ });
- it('should have a working grid view that passes accessibility tests', () => {
- cy.visit('/search?query='.concat(TEST_SEARCH_TERM));
+ it('should have a working grid view that passes accessibility tests', () => {
+ cy.visit('/search?query='.concat(query));
- // Click button in sidebar to display grid view
- cy.get('ds-search-sidebar [data-test="grid-view"]').click();
+ // Click button in sidebar to display grid view
+ cy.get('ds-search-sidebar [data-test="grid-view"]').click();
- // tag must be loaded
- cy.get('ds-search-page').should('be.visible');
+ // tag must be loaded
+ cy.get('ds-search-page').should('be.visible');
- // At least one grid object (card) should be displayed
- cy.get('[data-test="grid-object"]').should('be.visible');
+ // At least one grid object (card) should be displayed
+ cy.get('[data-test="grid-object"]').should('be.visible');
- // Analyze for accessibility issues
- testA11y('ds-search-page',
+ // Analyze for accessibility issues
+ testA11y('ds-search-page',
{
- rules: {
- // Search filters fail these two "moderate" impact rules
- 'heading-order': { enabled: false },
- 'landmark-unique': { enabled: false }
- }
- } as Options
- );
- });
+ rules: {
+ // 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 ed10b2d13aa..0ac7003a8b4 100644
--- a/cypress/e2e/submission.cy.ts
+++ b/cypress/e2e/submission.cy.ts
@@ -1,134 +1,227 @@
-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
- 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'));
-
- // 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);
-
- // Should redirect to /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 & it's value should be the selected collection
- cy.get('#collectionControlsMenuButton span').should('have.text', TEST_SUBMIT_COLLECTION_NAME);
-
- // 4 sections should be visible by default
- cy.get('div#section_traditionalpageone').should('be.visible');
- cy.get('div#section_traditionalpagetwo').should('be.visible');
- cy.get('div#section_upload').should('be.visible');
- cy.get('div#section_license').should('be.visible');
-
- // Discard button should work
- // Clicking it will display a confirmation, which we will confirm with another click
- cy.get('button#discard').click();
- cy.get('button#discard_submit').click();
+ // 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(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(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');
+
+ // The Submission edit form tag should be visible
+ 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', Cypress.env('DSPACE_TEST_SUBMIT_COLLECTION_NAME'));
+
+ // 4 sections should be visible by default
+ cy.get('div#section_traditionalpageone').should('be.visible');
+ cy.get('div#section_traditionalpagetwo').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: {
+ // 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();
+ cy.get('button#discard_submit').click();
+ });
+
+ it('should block submission & show errors if required fields are missing', () => {
+ // Create a new submission
+ 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(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();
+
+ // A warning alert should display.
+ cy.get('ds-notification div.alert-success').should('not.exist');
+ cy.get('ds-notification div.alert-warning').should('be.visible');
+
+ // First section should have an exclamation error in the header
+ // (as it has required fields)
+ cy.get('div#traditionalpageone-header i.fa-exclamation-circle').should('be.visible');
+
+ // Title field should have class "is-invalid" applied, as it's required
+ cy.get('input#dc_title').should('have.class', 'is-invalid');
+
+ // Date Year field should also have "is-valid" class
+ cy.get('input#dc_date_issued_year').should('have.class', 'is-invalid');
+
+ // FINALLY, cleanup after ourselves. This also exercises the MyDSpace delete button.
+ // Get our Submission URL, to parse out the ID of this submission
+ cy.location().then(fullUrl => {
+ // This will be the full path (/workspaceitems/[id]/edit)
+ const path = fullUrl.pathname;
+ // Split on the slashes
+ const subpaths = path.split('/');
+ // Part 2 will be the [id] of the submission
+ const id = subpaths[2];
+
+ // Even though form is incomplete, the "Save for Later" button should still work
+ cy.get('button#saveForLater').click();
+
+ // "Save for Later" should send us to MyDSpace
+ cy.url().should('include', '/mydspace');
+
+ // A success alert should be visible
+ cy.get('ds-notification div.alert-success').should('be.visible');
+ // Now, dismiss any open alert boxes (may be multiple, as tests run quickly)
+ cy.get('[data-dismiss="alert"]').click({ multiple: true });
+
+ // This is the GET command that will actually run the search
+ cy.intercept('GET', '/server/api/discover/search/objects*').as('search-results');
+ // On MyDSpace, find the submission we just saved via its ID
+ cy.get('[data-test="search-box"]').type(id);
+ cy.get('[data-test="search-button"]').click();
+
+ // Wait for search results to come back from the above GET command
+ cy.wait('@search-results');
+
+ // Delete our created submission & confirm deletion
+ cy.get('button#delete_' + id).click();
+ cy.get('button#delete_confirm').click();
});
+ });
- 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'));
+ it('should allow for deposit if all required fields completed & file uploaded', () => {
+ // Create a new submission
+ 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);
+ // This page is restricted, so we will be shown the login form. Fill it out & submit.
+ 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();
+ // Fill out all required fields (Title, Date)
+ cy.get('input#dc_title').type('DSpace logo uploaded via e2e tests');
+ cy.get('input#dc_date_issued_year').type('2022');
- // A warning alert should display.
- cy.get('ds-notification div.alert-success').should('not.exist');
- cy.get('ds-notification div.alert-warning').should('be.visible');
+ // Confirm the required license by checking checkbox
+ // (NOTE: requires "force:true" cause Cypress claims this checkbox is covered by its own )
+ cy.get('input#granted').check( { force: true } );
- // First section should have an exclamation error in the header
- // (as it has required fields)
- cy.get('div#traditionalpageone-header i.fa-exclamation-circle').should('be.visible');
+ // Before using Cypress drag & drop, we have to manually trigger the "dragover" event.
+ // This ensures our UI displays the dropzone that covers the entire submission page.
+ // (For some reason Cypress drag & drop doesn't trigger this even itself & upload won't work without this trigger)
+ cy.get('ds-uploader').trigger('dragover');
- // Title field should have class "is-invalid" applied, as it's required
- cy.get('input#dc_title').should('have.class', 'is-invalid');
+ // This is the POST command that will upload the file
+ cy.intercept('POST', '/server/api/submission/workspaceitems/*').as('upload');
- // Date Year field should also have "is-valid" class
- cy.get('input#dc_date_issued_year').should('have.class', 'is-invalid');
+ // 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.svg', {
+ action: 'drag-drop',
+ });
- // FINALLY, cleanup after ourselves. This also exercises the MyDSpace delete button.
- // Get our Submission URL, to parse out the ID of this submission
- cy.location().then(fullUrl => {
- // This will be the full path (/workspaceitems/[id]/edit)
- const path = fullUrl.pathname;
- // Split on the slashes
- const subpaths = path.split('/');
- // Part 2 will be the [id] of the submission
- const id = subpaths[2];
+ // Wait for upload to complete before proceeding
+ cy.wait('@upload');
- // Even though form is incomplete, the "Save for Later" button should still work
- cy.get('button#saveForLater').click();
+ // Wait for deposit button to not be disabled & click it.
+ cy.get('button#deposit').should('not.be.disabled').click();
- // "Save for Later" should send us to MyDSpace
- cy.url().should('include', '/mydspace');
+ // No warnings should exist. Instead, just successful deposit alert is displayed
+ cy.get('ds-notification div.alert-warning').should('not.exist');
+ cy.get('ds-notification div.alert-success').should('be.visible');
+ });
- // A success alert should be visible
- cy.get('ds-notification div.alert-success').should('be.visible');
- // Now, dismiss any open alert boxes (may be multiple, as tests run quickly)
- cy.get('[data-dismiss="alert"]').click({multiple: true});
+ 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 is the GET command that will actually run the search
- cy.intercept('GET', '/server/api/discover/search/objects*').as('search-results');
- // On MyDSpace, find the submission we just saved via its ID
- cy.get('[data-test="search-box"]').type(id);
- cy.get('[data-test="search-button"]').click();
+ // 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'));
- // Wait for search results to come back from the above GET command
- cy.wait('@search-results');
+ // 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();
- // Delete our created submission & confirm deletion
- cy.get('button#delete_' + id).click();
- cy.get('button#delete_confirm').click();
- });
- });
+ // This should display the (popup window)
+ cy.get('ds-create-item-parent-selector').should('be.visible');
- 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'));
+ // 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'));
- // 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);
+ // 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();
- // Fill out all required fields (Title, Date)
- cy.get('input#dc_title').type('DSpace logo uploaded via e2e tests');
- cy.get('input#dc_date_issued_year').type('2022');
+ // New URL should include /workspaceitems, as we've started a new submission
+ cy.url().should('include', '/workspaceitems');
- // Confirm the required license by checking checkbox
- // (NOTE: requires "force:true" cause Cypress claims this checkbox is covered by its own )
- cy.get('input#granted').check( {force: true} );
+ // The Submission edit form tag should be visible
+ cy.get('ds-submission-edit').should('be.visible');
- // Before using Cypress drag & drop, we have to manually trigger the "dragover" event.
- // This ensures our UI displays the dropzone that covers the entire submission page.
- // (For some reason Cypress drag & drop doesn't trigger this even itself & upload won't work without this trigger)
- cy.get('ds-uploader').trigger('dragover');
+ // 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'));
- // This is the POST command that will upload the file
- cy.intercept('POST', '/server/api/submission/workspaceitems/*').as('upload');
+ // 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');
- // 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', {
- action: 'drag-drop'
- });
+ // 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 },
+ },
- // Wait for upload to complete before proceeding
- cy.wait('@upload');
+ } as Options,
+ );
- // Wait for deposit button to not be disabled & click it.
- cy.get('button#deposit').should('not.be.disabled').click();
+ // Click the lookup button next to "Publication" field
+ cy.get('button[data-test="lookup-button"]').click();
- // No warnings should exist. Instead, just successful deposit alert is displayed
- cy.get('ds-notification div.alert-warning').should('not.exist');
- cy.get('ds-notification div.alert-success').should('be.visible');
+ // 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 00000000000..046bfe619fe
--- /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 ead38afb921..091f11d0f7e 100644
--- a/cypress/plugins/index.ts
+++ b/cypress/plugins/index.ts
@@ -1,35 +1,59 @@
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) => {
- on('task', {
- // Define "log" and "table" tasks, used for logging accessibility errors during CI
- // Borrowed from https://github.com/component-driven/cypress-axe#in-cypress-plugins-file
- log(message: string) {
- console.log(message);
- return null;
- },
- table(message: string) {
- console.table(message);
- return null;
- },
- // 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.
- readUIConfig() {
- // Check if we have a config.json in the src/assets. If so, use that.
- // This is where it's written when running "ng e2e" or "yarn serve"
- if (fs.existsSync('./src/assets/config.json')) {
- return fs.readFileSync('./src/assets/config.json', 'utf8');
- // Otherwise, check the dist/browser/assets
- // This is where it's written when running "serve:ssr", which is what CI uses to start the frontend
- } else if (fs.existsSync('./dist/browser/assets/config.json')) {
- return fs.readFileSync('./dist/browser/assets/config.json', 'utf8');
- }
+ on('task', {
+ // Define "log" and "table" tasks, used for logging accessibility errors during CI
+ // Borrowed from https://github.com/component-driven/cypress-axe#in-cypress-plugins-file
+ log(message: string) {
+ console.log(message);
+ return null;
+ },
+ table(message: string) {
+ console.table(message);
+ return null;
+ },
+ // 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.
+ readUIConfig() {
+ // Check if we have a config.json in the src/assets. If so, use that.
+ // This is where it's written when running "ng e2e" or "yarn serve"
+ if (fs.existsSync('./src/assets/config.json')) {
+ return fs.readFileSync('./src/assets/config.json', 'utf8');
+ // Otherwise, check the dist/browser/assets
+ // This is where it's written when running "serve:ssr", which is what CI uses to start the frontend
+ } else if (fs.existsSync('./dist/browser/assets/config.json')) {
+ return fs.readFileSync('./dist/browser/assets/config.json', 'utf8');
+ }
- return null;
- }
- });
+ 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 c70c4e37e12..8cc2c5c721b 100644
--- a/cypress/support/commands.ts
+++ b/cypress/support/commands.ts
@@ -3,13 +3,15 @@
// See docs at https://docs.cypress.io/api/cypress-api/custom-commands
// ***********************************************
-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 {
+ 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';
+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 +43,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,60 +63,33 @@ 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);
-
- // 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;
- }
-
- // 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));
- });
-
- // Remove cookie with fake CSRF token, as it's no longer needed
- cy.clearCookie(DSPACE_XSRF_COOKIE);
+ // 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');
+
+ // 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));
+ });
});
+ });
}
// Add as a Cypress command (i.e. assign to 'cy.login')
Cypress.Commands.add('login', login);
@@ -118,12 +100,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 +123,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);
- });
-
- // Remove cookie with fake CSRF token, as it's no longer needed
- cy.clearCookie(DSPACE_XSRF_COOKIE);
+ // 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);
+ });
});
+ });
}
// 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 dd7ee1824c4..73d3c76a990 100644
--- a/cypress/support/e2e.ts
+++ b/cypress/support/e2e.ts
@@ -15,49 +15,57 @@
// Import all custom Commands (from commands.ts) for all tests
import './commands';
-
// Import Cypress Axe tools for all tests
// https://github.com/component-driven/cypress-axe
import 'cypress-axe';
-// 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}');
-});
+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);
-// 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';
- });
-});*/
+ // 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);
-// 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';
+// 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);
+});
+// 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/cypress/support/utils.ts b/cypress/support/utils.ts
index 96575969e85..9a9ea1121ba 100644
--- a/cypress/support/utils.ts
+++ b/cypress/support/utils.ts
@@ -5,26 +5,26 @@ import { Options } from 'cypress-axe';
// Uses 'log' and 'table' tasks defined in ../plugins/index.ts
// Borrowed from https://github.com/component-driven/cypress-axe#in-your-spec-file
function terminalLog(violations: Result[]) {
- cy.task(
- 'log',
- `${violations.length} accessibility violation${violations.length === 1 ? '' : 's'} ${violations.length === 1 ? 'was' : 'were'} detected`
- );
- // pluck specific keys to keep the table readable
- const violationData = violations.map(
- ({ id, impact, description, helpUrl, nodes }) => ({
- id,
- impact,
- description,
- helpUrl,
- nodes: nodes.length,
- html: nodes.map(node => node.html)
- })
- );
+ cy.task(
+ 'log',
+ `${violations.length} accessibility violation${violations.length === 1 ? '' : 's'} ${violations.length === 1 ? 'was' : 'were'} detected`,
+ );
+ // pluck specific keys to keep the table readable
+ const violationData = violations.map(
+ ({ id, impact, description, helpUrl, nodes }) => ({
+ id,
+ impact,
+ description,
+ helpUrl,
+ nodes: nodes.length,
+ html: nodes.map(node => node.html),
+ }),
+ );
- // Print violations as an array, since 'node.html' above often breaks table alignment
- cy.task('log', violationData);
- // Optionally, uncomment to print as a table
- // cy.task('table', violationData);
+ // Print violations as an array, since 'node.html' above often breaks table alignment
+ cy.task('log', violationData);
+ // Optionally, uncomment to print as a table
+ // cy.task('table', violationData);
}
@@ -32,13 +32,13 @@ function terminalLog(violations: Result[]) {
// while also ensuring any violations are logged to the terminal (see terminalLog above)
// This method MUST be called after cy.visit(), as cy.injectAxe() must be called after page load
export const testA11y = (context?: any, options?: Options) => {
- cy.injectAxe();
- cy.configureAxe({
- rules: [
- // Disable color contrast checks as they are inaccurate / result in a lot of false positives
- // See also open issues in axe-core: https://github.com/dequelabs/axe-core/labels/color%20contrast
- { id: 'color-contrast', enabled: false },
- ]
- });
- cy.checkA11y(context, options, terminalLog);
+ cy.injectAxe();
+ cy.configureAxe({
+ rules: [
+ // Disable color contrast checks as they are inaccurate / result in a lot of false positives
+ // See also open issues in axe-core: https://github.com/dequelabs/axe-core/labels/color%20contrast
+ { id: 'color-contrast', enabled: false },
+ ],
+ });
+ cy.checkA11y(context, options, terminalLog);
};
diff --git a/cypress/tsconfig.json b/cypress/tsconfig.json
index 58083003cda..51237b5e954 100644
--- a/cypress/tsconfig.json
+++ b/cypress/tsconfig.json
@@ -4,10 +4,11 @@
"**/*.ts"
],
"compilerOptions": {
+ "sourceMap": false,
"types": [
"cypress",
"cypress-axe",
"node"
]
}
-}
\ No newline at end of file
+}
diff --git a/docker/README.md b/docker/README.md
index 37d071a86f8..6360124b601 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -20,17 +20,17 @@ the Docker compose scripts in this 'docker' folder.
### Dockerfile
-This Dockerfile is used to build a *development* DSpace 7 Angular UI image, published as 'dspace/dspace-angular'
+This Dockerfile is used to build a *development* DSpace Angular UI image, published as 'dspace/dspace-angular'
```
-docker build -t dspace/dspace-angular:dspace-7_x .
+docker build -t dspace/dspace-angular:dspace-8_x .
```
This image is built *automatically* after each commit is made to the `main` branch.
Admins to our DockerHub repo can manually publish with the following command.
```
-docker push dspace/dspace-angular:dspace-7_x
+docker push dspace/dspace-angular:dspace-8_x
```
### Dockerfile.dist
@@ -39,18 +39,18 @@ The `Dockerfile.dist` is used to generate a *production* build and runtime envir
```bash
# build the latest image
-docker build -f Dockerfile.dist -t dspace/dspace-angular:dspace-7_x-dist .
+docker build -f Dockerfile.dist -t dspace/dspace-angular:dspace-8_x-dist .
```
A default/demo version of this image is built *automatically*.
## 'docker' directory
- docker-compose.yml
- - Starts DSpace Angular with Docker Compose from the current branch. This file assumes that a DSpace 7 REST instance will also be started in Docker.
+ - Starts DSpace Angular with Docker Compose from the current branch. This file assumes that a DSpace REST instance will also be started in Docker.
- docker-compose-rest.yml
- - Runs a published instance of the DSpace 7 REST API - persists data in Docker volumes
+ - Runs a published instance of the DSpace REST API - persists data in Docker volumes
- docker-compose-ci.yml
- - Runs a published instance of the DSpace 7 REST API for CI testing. The database is re-populated from a SQL dump on each startup.
+ - Runs a published instance of the DSpace REST API for CI testing. The database is re-populated from a SQL dump on each startup.
- cli.yml
- Docker compose file that provides a DSpace CLI container to work with a running DSpace REST container.
- cli.assetstore.yml
@@ -59,19 +59,19 @@ A default/demo version of this image is built *automatically*.
## To refresh / pull DSpace images from Dockerhub
```
-docker-compose -f docker/docker-compose.yml pull
+docker compose -f docker/docker-compose.yml pull
```
## To build DSpace images using code in your branch
```
-docker-compose -f docker/docker-compose.yml build
+docker compose -f docker/docker-compose.yml build
```
## To start DSpace (REST and Angular) from your branch
This command provides a quick way to start both the frontend & backend from this single codebase
```
-docker-compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
+docker compose -p d8 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
```
Keep in mind, you may also start the backend by cloning the 'DSpace/DSpace' GitHub repository separately. See the next section.
@@ -86,14 +86,14 @@ _The system will be started in 2 steps. Each step shares the same docker network
From 'DSpace/DSpace' clone (build first as needed):
```
-docker-compose -p d7 up -d
+docker compose -p d8 up -d
```
NOTE: More detailed instructions on starting the backend via Docker can be found in the [Docker Compose instructions for the Backend](https://github.com/DSpace/DSpace/blob/main/dspace/src/main/docker-compose/README.md).
From 'DSpace/dspace-angular' clone (build first as needed)
```
-docker-compose -p d7 -f docker/docker-compose.yml up -d
+docker compose -p d8 -f docker/docker-compose.yml up -d
```
At this point, you should be able to access the UI from http://localhost:4000,
@@ -105,21 +105,21 @@ This allows you to run the Angular UI in *production* mode, pointing it at the d
(https://demo.dspace.org/server/ or https://sandbox.dspace.org/server/).
```
-docker-compose -f docker/docker-compose-dist.yml pull
-docker-compose -f docker/docker-compose-dist.yml build
-docker-compose -p d7 -f docker/docker-compose-dist.yml up -d
+docker compose -f docker/docker-compose-dist.yml pull
+docker compose -f docker/docker-compose-dist.yml build
+docker compose -p d8 -f docker/docker-compose-dist.yml up -d
```
## Ingest test data from AIPDIR
Create an administrator
```
-docker-compose -p d7 -f docker/cli.yml run --rm dspace-cli create-administrator -e test@test.edu -f admin -l user -p admin -c en
+docker compose -p d8 -f docker/cli.yml run --rm dspace-cli create-administrator -e test@test.edu -f admin -l user -p admin -c en
```
Load content from AIP files
```
-docker-compose -p d7 -f docker/cli.yml -f ./docker/cli.ingest.yml run --rm dspace-cli
+docker compose -p d8 -f docker/cli.yml -f ./docker/cli.ingest.yml run --rm dspace-cli
```
## Alternative Ingest - Use Entities dataset
@@ -127,12 +127,12 @@ _Delete your docker volumes or use a unique project (-p) name_
Start DSpace with Database Content from a database dump
```
-docker-compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml -f docker/db.entities.yml up -d
+docker compose -p d8 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml -f docker/db.entities.yml up -d
```
Load assetstore content and trigger a re-index of the repository
```
-docker-compose -p d7 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli
+docker compose -p d8 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli
```
## End to end testing of the REST API (runs in GitHub Actions CI).
@@ -140,5 +140,5 @@ _In this instance, only the REST api runs in Docker using the Entities dataset.
This command is only really useful for testing our Continuous Integration process.
```
-docker-compose -p d7ci -f docker/docker-compose-ci.yml up -d
+docker compose -p d8ci -f docker/docker-compose-ci.yml up -d
```
diff --git a/docker/cli.assetstore.yml b/docker/cli.assetstore.yml
index 40e4974c7c7..98f74148610 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 1db241af3bf..31563ccc083 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:
@@ -34,5 +32,7 @@ services:
/dspace/bin/dspace packager -r -a -t AIP -e $${ADMIN_EMAIL} -f -u SITE*.zip
/dspace/bin/dspace database update-sequences
+ touch /dspace/solr/search/conf/reindex.flag
- /dspace/bin/dspace index-discovery
+ /dspace/bin/dspace oai import
+ /dspace/bin/dspace oai clean-cache
diff --git a/docker/cli.yml b/docker/cli.yml
index 54b83d45036..7c17b14b1bd 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 d8" means it will be named "d8_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-8_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 6473bf2e385..464253f07be 100644
--- a/docker/db.entities.yml
+++ b/docker/db.entities.yml
@@ -12,14 +12,13 @@
# 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-8_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
+ # NOTE: currently there is no dspace8 version
- LOADSQL=https://github.com/DSpace-Labs/AIP-Files/releases/download/demo-entities-data/dspace7-entities-data.sql
dspace:
### OVERRIDE default 'entrypoint' in 'docker-compose-rest.yml' ####
@@ -29,23 +28,11 @@ services:
# 3. (Custom for Entities) enable Entity-specific collection submission mappings in item-submission.xml
# This 'sed' command inserts the sample configurations specific to the Entities data set, see:
# https://github.com/DSpace/DSpace/blob/main/dspace/config/item-submission.xml#L36-L49
- # 4. Finally, start Tomcat
+ # 4. Finally, start DSpace
entrypoint:
- /bin/bash
- '-c'
- |
while (! /dev/null 2>&1; do sleep 1; done;
/dspace/bin/dspace database migrate ignored
- sed -i '/name-map collection-handle="default".*/a \\n \
- \
- \
- \
- \
- \
- \
- \
- \
- \
- \
- ' /dspace/config/item-submission.xml
- catalina.sh run
\ No newline at end of file
+ java -jar /dspace/webapps/server-boot.jar --dspace.dir=/dspace
diff --git a/docker/docker-compose-ci.yml b/docker/docker-compose-ci.yml
index 9ec8fe664a3..d2589bb3f32 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-8_x-test}"
depends_on:
- dspacedb
- image: dspace/dspace:dspace-7_x-test
networks:
- dspacenet:
+ - dspacenet
ports:
- published: 8080
target: 8080
@@ -45,46 +45,46 @@ 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)
- # 3. Finally, start Tomcat
+ # 3. Finally, start DSpace
entrypoint:
- /bin/bash
- '-c'
- |
while (! /dev/null 2>&1; do sleep 1; done;
/dspace/bin/dspace database migrate ignored
- catalina.sh run
+ java -jar /dspace/webapps/server-boot.jar --dspace.dir=/dspace
# DSpace database container
# 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-8_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
+ # NOTE: currently there is no dspace8 version
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-8_x}"
networks:
- dspacenet:
+ - dspacenet
ports:
- published: 8983
target: 8983
@@ -92,9 +92,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 +100,20 @@ 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
+ precreate-core qaevent /opt/solr/server/solr/configsets/qaevent
+ cp -r /opt/solr/server/solr/configsets/qaevent/* qaevent
+ precreate-core suggestion /opt/solr/server/solr/configsets/suggestion
+ cp -r /opt/solr/server/solr/configsets/suggestion/* suggestion
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 00225e8052a..03e5e9da709 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: demo.dspace.org
+ DSPACE_REST_HOST: sandbox.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-8_x}-dist"
build:
context: ..
dockerfile: Dockerfile.dist
diff --git a/docker/docker-compose-rest.yml b/docker/docker-compose-rest.yml
index e5f62600e70..37a5d23e77b 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,55 +39,55 @@ 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-8_x-test}"
depends_on:
- dspacedb
networks:
- dspacenet:
+ - dspacenet
ports:
- published: 8080
target: 8080
stdin_open: true
tty: true
volumes:
+ # Keep DSpace assetstore directory between reboots
- 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
- # 3. Finally, start Tomcat
+ # 3. Finally, start DSpace
entrypoint:
- /bin/bash
- '-c'
- |
while (! /dev/null 2>&1; do sleep 1; done;
/dspace/bin/dspace database migrate
- catalina.sh run
+ java -jar /dspace/webapps/server-boot.jar --dspace.dir=/dspace
# 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-8_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-8_x}"
networks:
- dspacenet:
+ - dspacenet
ports:
- published: 8983
target: 8983
@@ -101,7 +101,7 @@ services:
# * First, run precreate-core to create the core (if it doesn't yet exist). If exists already, this is a no-op
# * Second, copy configsets to this core:
# Updates to Solr configs require the container to be rebuilt/restarted:
- # `docker-compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d --build dspacesolr`
+ # `docker compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d --build dspacesolr`
entrypoint:
- /bin/bash
- '-c'
@@ -115,10 +115,12 @@ services:
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
+ precreate-core qaevent /opt/solr/server/solr/configsets/qaevent
+ cp -r /opt/solr/server/solr/configsets/qaevent/* qaevent
+ precreate-core suggestion /opt/solr/server/solr/configsets/suggestion
+ cp -r /opt/solr/server/solr/configsets/suggestion/* suggestion
exec solr -f
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 1387b1de396..8e85520f9fa 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-8_x}"
build:
context: ..
dockerfile: Dockerfile
diff --git a/docs/lint/html/index.md b/docs/lint/html/index.md
new file mode 100644
index 00000000000..e134e1070f4
--- /dev/null
+++ b/docs/lint/html/index.md
@@ -0,0 +1,5 @@
+[DSpace ESLint plugins](../../../lint/README.md) > HTML rules
+_______
+
+- [`dspace-angular-html/themed-component-usages`](./rules/themed-component-usages.md): Themeable components should be used via the selector of their `ThemedComponent` wrapper class
+- [`dspace-angular-html/no-disabled-attribute-on-button`](./rules/no-disabled-attribute-on-button.md): Buttons should use the `dsBtnDisabled` directive instead of the HTML `disabled` attribute.
diff --git a/docs/lint/html/rules/no-disabled-attribute-on-button.md b/docs/lint/html/rules/no-disabled-attribute-on-button.md
new file mode 100644
index 00000000000..d9d39ce82ca
--- /dev/null
+++ b/docs/lint/html/rules/no-disabled-attribute-on-button.md
@@ -0,0 +1,78 @@
+[DSpace ESLint plugins](../../../../lint/README.md) > [HTML rules](../index.md) > `dspace-angular-html/no-disabled-attribute-on-button`
+_______
+
+Buttons should use the `dsBtnDisabled` directive instead of the HTML `disabled` attribute.
+ This should be done to ensure that users with a screen reader are able to understand that the a button button is present, and that it is disabled.
+ The native html disabled attribute does not allow users to navigate to the button by keyboard, and thus they have no way of knowing that the button is present.
+
+_______
+
+[Source code](../../../../lint/src/rules/html/no-disabled-attribute-on-button.ts)
+
+### Examples
+
+
+#### Valid code
+
+##### should use [dsBtnDisabled] in HTML templates
+
+```html
+
+```
+
+##### disabled attribute is still valid on non-button elements
+
+```html
+
+```
+
+##### [disabled] attribute is still valid on non-button elements
+
+```html
+
+```
+
+##### angular dynamic attributes that use disabled are still valid
+
+```html
+
+```
+
+
+
+
+#### Invalid code & automatic fixes
+
+##### should not use disabled attribute in HTML templates
+
+```html
+
+```
+Will produce the following error(s):
+```
+Buttons should use the `dsBtnDisabled` directive instead of the `disabled` attribute.
+```
+
+Result of `yarn lint --fix`:
+```html
+
+```
+
+
+##### should not use [disabled] attribute in HTML templates
+
+```html
+
+```
+Will produce the following error(s):
+```
+Buttons should use the `dsBtnDisabled` directive instead of the `disabled` attribute.
+```
+
+Result of `yarn lint --fix`:
+```html
+
+```
+
+
+
diff --git a/docs/lint/html/rules/themed-component-usages.md b/docs/lint/html/rules/themed-component-usages.md
new file mode 100644
index 00000000000..a04fe1c770a
--- /dev/null
+++ b/docs/lint/html/rules/themed-component-usages.md
@@ -0,0 +1,110 @@
+[DSpace ESLint plugins](../../../../lint/README.md) > [HTML rules](../index.md) > `dspace-angular-html/themed-component-usages`
+_______
+
+Themeable components should be used via the selector of their `ThemedComponent` wrapper class
+
+This ensures that custom themes can correctly override _all_ instances of this component.
+The only exception to this rule are unit tests, where we may want to use the base component in order to keep the test setup simple.
+
+
+_______
+
+[Source code](../../../../lint/src/rules/html/themed-component-usages.ts)
+
+### Examples
+
+
+#### Valid code
+
+##### use no-prefix selectors in HTML templates
+
+```html
+
+
+
+```
+
+##### use no-prefix selectors in TypeScript templates
+
+```html
+@Component({
+ template: ''
+})
+class Test {
+}
+```
+
+##### use no-prefix selectors in TypeScript test templates
+
+Filename: `lint/test/fixture/src/test.spec.ts`
+
+```html
+@Component({
+ template: ''
+})
+class Test {
+}
+```
+
+##### base selectors are also allowed in TypeScript test templates
+
+Filename: `lint/test/fixture/src/test.spec.ts`
+
+```html
+@Component({
+ template: ''
+})
+class Test {
+}
+```
+
+
+
+
+#### Invalid code & automatic fixes
+
+##### themed override selectors are not allowed in HTML templates
+
+```html
+
+
+
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper's selector
+Themeable components should be used via their ThemedComponent wrapper's selector
+Themeable components should be used via their ThemedComponent wrapper's selector
+```
+
+Result of `yarn lint --fix`:
+```html
+
+
+
+```
+
+
+##### base selectors are not allowed in HTML templates
+
+```html
+
+
+
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper's selector
+Themeable components should be used via their ThemedComponent wrapper's selector
+Themeable components should be used via their ThemedComponent wrapper's selector
+```
+
+Result of `yarn lint --fix`:
+```html
+
+
+
+```
+
+
+
diff --git a/docs/lint/ts/index.md b/docs/lint/ts/index.md
new file mode 100644
index 00000000000..ed060c946e8
--- /dev/null
+++ b/docs/lint/ts/index.md
@@ -0,0 +1,6 @@
+[DSpace ESLint plugins](../../../lint/README.md) > TypeScript rules
+_______
+
+- [`dspace-angular-ts/themed-component-classes`](./rules/themed-component-classes.md): Formatting rules for themeable component classes
+- [`dspace-angular-ts/themed-component-selectors`](./rules/themed-component-selectors.md): Themeable component selectors should follow the DSpace convention
+- [`dspace-angular-ts/themed-component-usages`](./rules/themed-component-usages.md): Themeable components should be used via their `ThemedComponent` wrapper class
diff --git a/docs/lint/ts/rules/themed-component-classes.md b/docs/lint/ts/rules/themed-component-classes.md
new file mode 100644
index 00000000000..1f4ec72801c
--- /dev/null
+++ b/docs/lint/ts/rules/themed-component-classes.md
@@ -0,0 +1,257 @@
+[DSpace ESLint plugins](../../../../lint/README.md) > [TypeScript rules](../index.md) > `dspace-angular-ts/themed-component-classes`
+_______
+
+Formatting rules for themeable component classes
+
+- All themeable components must be standalone.
+- The base component must always be imported in the `ThemedComponent` wrapper. This ensures that it is always sufficient to import just the wrapper whenever we use the component.
+
+
+_______
+
+[Source code](../../../../lint/src/rules/ts/themed-component-classes.ts)
+
+### Examples
+
+
+#### Valid code
+
+##### Regular non-themeable component
+
+```typescript
+@Component({
+ selector: 'ds-something',
+ standalone: true,
+})
+class Something {
+}
+```
+
+##### Base component
+
+```typescript
+@Component({
+ selector: 'ds-base-test-themable',
+ standalone: true,
+})
+class TestThemeableTomponent {
+}
+```
+
+##### Wrapper component
+
+Filename: `lint/test/fixture/src/app/test/themed-test-themeable.component.ts`
+
+```typescript
+@Component({
+ selector: 'ds-test-themable',
+ standalone: true,
+ imports: [
+ TestThemeableComponent,
+ ],
+})
+class ThemedTestThemeableTomponent extends ThemedComponent {
+}
+```
+
+##### Override component
+
+Filename: `lint/test/fixture/src/themes/test/app/test/test-themeable.component.ts`
+
+```typescript
+@Component({
+ selector: 'ds-themed-test-themable',
+ standalone: true,
+})
+class Override extends BaseComponent {
+}
+```
+
+
+
+
+#### Invalid code & automatic fixes
+
+##### Base component must be standalone
+
+```typescript
+@Component({
+ selector: 'ds-base-test-themable',
+})
+class TestThemeableComponent {
+}
+```
+Will produce the following error(s):
+```
+Themeable components must be standalone
+```
+
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+ selector: 'ds-base-test-themable',
+ standalone: true,
+})
+class TestThemeableComponent {
+}
+```
+
+
+##### Wrapper component must be standalone and import base component
+
+Filename: `lint/test/fixture/src/app/test/themed-test-themeable.component.ts`
+
+```typescript
+@Component({
+ selector: 'ds-test-themable',
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+```
+Will produce the following error(s):
+```
+Themeable component wrapper classes must be standalone and import the base class
+```
+
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+ selector: 'ds-test-themable',
+ standalone: true,
+ imports: [TestThemeableComponent],
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+```
+
+
+##### Wrapper component must import base component (array present but empty)
+
+Filename: `lint/test/fixture/src/app/test/themed-test-themeable.component.ts`
+
+```typescript
+@Component({
+ selector: 'ds-test-themable',
+ standalone: true,
+ imports: [],
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+```
+Will produce the following error(s):
+```
+Themed component wrapper classes must only import the base class
+```
+
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+ selector: 'ds-test-themable',
+ standalone: true,
+ imports: [TestThemeableComponent],
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+```
+
+
+##### Wrapper component must import base component (array is wrong)
+
+Filename: `lint/test/fixture/src/app/test/themed-test-themeable.component.ts`
+
+```typescript
+import { SomethingElse } from './somewhere-else';
+
+@Component({
+ selector: 'ds-test-themable',
+ standalone: true,
+ imports: [
+ SomethingElse,
+ ],
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+```
+Will produce the following error(s):
+```
+Themed component wrapper classes must only import the base class
+```
+
+Result of `yarn lint --fix`:
+```typescript
+import { SomethingElse } from './somewhere-else';
+
+@Component({
+ selector: 'ds-test-themable',
+ standalone: true,
+ imports: [TestThemeableComponent],
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+```
+
+
+##### Wrapper component must import base component (array is wrong)
+
+Filename: `lint/test/fixture/src/app/test/themed-test-themeable.component.ts`
+
+```typescript
+import { Something, SomethingElse } from './somewhere-else';
+
+@Component({
+ selector: 'ds-test-themable',
+ standalone: true,
+ imports: [
+ SomethingElse,
+ ],
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+```
+Will produce the following error(s):
+```
+Themed component wrapper classes must only import the base class
+```
+
+Result of `yarn lint --fix`:
+```typescript
+import { Something, SomethingElse } from './somewhere-else';
+
+@Component({
+ selector: 'ds-test-themable',
+ standalone: true,
+ imports: [TestThemeableComponent],
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+```
+
+
+##### Override component must be standalone
+
+Filename: `lint/test/fixture/src/themes/test/app/test/test-themeable.component.ts`
+
+```typescript
+@Component({
+ selector: 'ds-themed-test-themable',
+})
+class Override extends BaseComponent {
+}
+```
+Will produce the following error(s):
+```
+Themeable components must be standalone
+```
+
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+ selector: 'ds-themed-test-themable',
+ standalone: true,
+})
+class Override extends BaseComponent {
+}
+```
+
+
+
diff --git a/docs/lint/ts/rules/themed-component-selectors.md b/docs/lint/ts/rules/themed-component-selectors.md
new file mode 100644
index 00000000000..f4d0ea177c9
--- /dev/null
+++ b/docs/lint/ts/rules/themed-component-selectors.md
@@ -0,0 +1,156 @@
+[DSpace ESLint plugins](../../../../lint/README.md) > [TypeScript rules](../index.md) > `dspace-angular-ts/themed-component-selectors`
+_______
+
+Themeable component selectors should follow the DSpace convention
+
+Each themeable component is comprised of a base component, a wrapper component and any number of themed components
+- Base components should have a selector starting with `ds-base-`
+- Themed components should have a selector starting with `ds-themed-`
+- Wrapper components should have a selector starting with `ds-`, but not `ds-base-` or `ds-themed-`
+ - This is the regular DSpace selector prefix
+ - **When making a regular component themeable, its selector prefix should be changed to `ds-base-`, and the new wrapper's component should reuse the previous selector**
+
+Unit tests are exempt from this rule, because they may redefine components using the same class name as other themeable components elsewhere in the source.
+
+
+_______
+
+[Source code](../../../../lint/src/rules/ts/themed-component-selectors.ts)
+
+### Examples
+
+
+#### Valid code
+
+##### Regular non-themeable component selector
+
+```typescript
+@Component({
+ selector: 'ds-something',
+})
+class Something {
+}
+```
+
+##### Themeable component selector should replace the original version, unthemed version should be changed to ds-base-
+
+```typescript
+@Component({
+ selector: 'ds-base-something',
+})
+class Something {
+}
+
+@Component({
+ selector: 'ds-something',
+})
+class ThemedSomething extends ThemedComponent {
+}
+
+@Component({
+ selector: 'ds-themed-something',
+})
+class OverrideSomething extends Something {
+}
+```
+
+##### Other themed component wrappers should not interfere
+
+```typescript
+@Component({
+ selector: 'ds-something',
+})
+class Something {
+}
+
+@Component({
+ selector: 'ds-something-else',
+})
+class ThemedSomethingElse extends ThemedComponent {
+}
+```
+
+
+
+
+#### Invalid code & automatic fixes
+
+##### Wrong selector for base component
+
+Filename: `lint/test/fixture/src/app/test/test-themeable.component.ts`
+
+```typescript
+@Component({
+ selector: 'ds-something',
+})
+class TestThemeableComponent {
+}
+```
+Will produce the following error(s):
+```
+Unthemed version of themeable component should have a selector starting with 'ds-base-'
+```
+
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+ selector: 'ds-base-something',
+})
+class TestThemeableComponent {
+}
+```
+
+
+##### Wrong selector for wrapper component
+
+Filename: `lint/test/fixture/src/app/test/themed-test-themeable.component.ts`
+
+```typescript
+@Component({
+ selector: 'ds-themed-something',
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+```
+Will produce the following error(s):
+```
+Themed component wrapper of themeable component shouldn't have a selector starting with 'ds-themed-'
+```
+
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+ selector: 'ds-something',
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+```
+
+
+##### Wrong selector for theme override
+
+Filename: `lint/test/fixture/src/themes/test/app/test/test-themeable.component.ts`
+
+```typescript
+@Component({
+ selector: 'ds-something',
+})
+class TestThememeableComponent extends BaseComponent {
+}
+```
+Will produce the following error(s):
+```
+Theme override of themeable component should have a selector starting with 'ds-themed-'
+```
+
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+ selector: 'ds-themed-something',
+})
+class TestThememeableComponent extends BaseComponent {
+}
+```
+
+
+
diff --git a/docs/lint/ts/rules/themed-component-usages.md b/docs/lint/ts/rules/themed-component-usages.md
new file mode 100644
index 00000000000..16ccb701c20
--- /dev/null
+++ b/docs/lint/ts/rules/themed-component-usages.md
@@ -0,0 +1,332 @@
+[DSpace ESLint plugins](../../../../lint/README.md) > [TypeScript rules](../index.md) > `dspace-angular-ts/themed-component-usages`
+_______
+
+Themeable components should be used via their `ThemedComponent` wrapper class
+
+This ensures that custom themes can correctly override _all_ instances of this component.
+There are a few exceptions where the base class can still be used:
+- Class declaration expressions (otherwise we can't declare, extend or override the class in the first place)
+- Angular modules (except for routing modules)
+- Angular `@ViewChild` decorators
+- Type annotations
+
+
+_______
+
+[Source code](../../../../lint/src/rules/ts/themed-component-usages.ts)
+
+### Examples
+
+
+#### Valid code
+
+##### allow wrapper class usages
+
+```typescript
+import { ThemedTestThemeableComponent } from './app/test/themed-test-themeable.component';
+
+const config = {
+ a: ThemedTestThemeableComponent,
+ b: ChipsComponent,
+}
+```
+
+##### allow base class in class declaration
+
+```typescript
+export class TestThemeableComponent {
+}
+```
+
+##### allow inheriting from base class
+
+```typescript
+import { TestThemeableComponent } from './app/test/test-themeable.component';
+
+export class ThemedAdminSidebarComponent extends ThemedComponent {
+}
+```
+
+##### allow base class in ViewChild
+
+```typescript
+import { TestThemeableComponent } from './app/test/test-themeable.component';
+
+export class Something {
+ @ViewChild(TestThemeableComponent) test: TestThemeableComponent;
+}
+```
+
+##### allow wrapper selectors in test queries
+
+Filename: `lint/test/fixture/src/app/test/test.component.spec.ts`
+
+```typescript
+By.css('ds-themeable');
+By.css('#test > ds-themeable > #nest');
+```
+
+##### allow wrapper selectors in cypress queries
+
+Filename: `lint/test/fixture/src/app/test/test.component.cy.ts`
+
+```typescript
+By.css('ds-themeable');
+By.css('#test > ds-themeable > #nest');
+```
+
+
+
+
+#### Invalid code & automatic fixes
+
+##### disallow direct usages of base class
+
+```typescript
+import { TestThemeableComponent } from './app/test/test-themeable.component';
+import { TestComponent } from './app/test/test.component';
+
+const config = {
+ a: TestThemeableComponent,
+ b: TestComponent,
+}
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+Themeable components should be used via their ThemedComponent wrapper
+```
+
+Result of `yarn lint --fix`:
+```typescript
+import { ThemedTestThemeableComponent } from './app/test/themed-test-themeable.component';
+import { TestComponent } from './app/test/test.component';
+
+const config = {
+ a: ThemedTestThemeableComponent,
+ b: TestComponent,
+}
+```
+
+
+##### disallow direct usages of base class, keep other imports
+
+```typescript
+import { Something, TestThemeableComponent } from './app/test/test-themeable.component';
+import { TestComponent } from './app/test/test.component';
+
+const config = {
+ a: TestThemeableComponent,
+ b: TestComponent,
+ c: Something,
+}
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+Themeable components should be used via their ThemedComponent wrapper
+```
+
+Result of `yarn lint --fix`:
+```typescript
+import { Something } from './app/test/test-themeable.component';
+import { ThemedTestThemeableComponent } from './app/test/themed-test-themeable.component';
+import { TestComponent } from './app/test/test.component';
+
+const config = {
+ a: ThemedTestThemeableComponent,
+ b: TestComponent,
+ c: Something,
+}
+```
+
+
+##### handle array replacements correctly
+
+```typescript
+const DECLARATIONS = [
+ Something,
+ TestThemeableComponent,
+ Something,
+ ThemedTestThemeableComponent,
+];
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+```
+
+Result of `yarn lint --fix`:
+```typescript
+const DECLARATIONS = [
+ Something,
+ Something,
+ ThemedTestThemeableComponent,
+];
+```
+
+
+##### disallow override selector in test queries
+
+Filename: `lint/test/fixture/src/app/test/test.component.spec.ts`
+
+```typescript
+By.css('ds-themed-themeable');
+By.css('#test > ds-themed-themeable > #nest');
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+Themeable components should be used via their ThemedComponent wrapper
+```
+
+Result of `yarn lint --fix`:
+```typescript
+By.css('ds-themeable');
+By.css('#test > ds-themeable > #nest');
+```
+
+
+##### disallow base selector in test queries
+
+Filename: `lint/test/fixture/src/app/test/test.component.spec.ts`
+
+```typescript
+By.css('ds-base-themeable');
+By.css('#test > ds-base-themeable > #nest');
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+Themeable components should be used via their ThemedComponent wrapper
+```
+
+Result of `yarn lint --fix`:
+```typescript
+By.css('ds-themeable');
+By.css('#test > ds-themeable > #nest');
+```
+
+
+##### disallow override selector in cypress queries
+
+Filename: `lint/test/fixture/src/app/test/test.component.cy.ts`
+
+```typescript
+cy.get('ds-themed-themeable');
+cy.get('#test > ds-themed-themeable > #nest');
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+Themeable components should be used via their ThemedComponent wrapper
+```
+
+Result of `yarn lint --fix`:
+```typescript
+cy.get('ds-themeable');
+cy.get('#test > ds-themeable > #nest');
+```
+
+
+##### disallow base selector in cypress queries
+
+Filename: `lint/test/fixture/src/app/test/test.component.cy.ts`
+
+```typescript
+cy.get('ds-base-themeable');
+cy.get('#test > ds-base-themeable > #nest');
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+Themeable components should be used via their ThemedComponent wrapper
+```
+
+Result of `yarn lint --fix`:
+```typescript
+cy.get('ds-themeable');
+cy.get('#test > ds-themeable > #nest');
+```
+
+
+##### edge case: unable to find usage node through usage token, but import is still flagged and fixed
+
+Filename: `lint/test/fixture/src/themes/test/app/test/other-themeable.component.ts`
+
+```typescript
+import { Component } from '@angular/core';
+
+import { Context } from './app/core/shared/context.model';
+import { TestThemeableComponent } from '../../../../app/test/test-themeable.component';
+
+@Component({
+ standalone: true,
+ imports: [TestThemeableComponent],
+})
+export class UsageComponent {
+}
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+Themeable components should be used via their ThemedComponent wrapper
+```
+
+Result of `yarn lint --fix`:
+```typescript
+import { Component } from '@angular/core';
+
+import { Context } from './app/core/shared/context.model';
+import { ThemedTestThemeableComponent } from '../../../../app/test/themed-test-themeable.component';
+
+@Component({
+ standalone: true,
+ imports: [ThemedTestThemeableComponent],
+})
+export class UsageComponent {
+}
+```
+
+
+##### edge case edge case: both are imported, only wrapper is retained
+
+Filename: `lint/test/fixture/src/themes/test/app/test/other-themeable.component.ts`
+
+```typescript
+import { Component } from '@angular/core';
+
+import { Context } from './app/core/shared/context.model';
+import { TestThemeableComponent } from '../../../../app/test/test-themeable.component';
+import { ThemedTestThemeableComponent } from '../../../../app/test/themed-test-themeable.component';
+
+@Component({
+ standalone: true,
+ imports: [TestThemeableComponent, ThemedTestThemeableComponent],
+})
+export class UsageComponent {
+}
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+Themeable components should be used via their ThemedComponent wrapper
+```
+
+Result of `yarn lint --fix`:
+```typescript
+import { Component } from '@angular/core';
+
+import { Context } from './app/core/shared/context.model';
+import { ThemedTestThemeableComponent } from '../../../../app/test/themed-test-themeable.component';
+
+@Component({
+ standalone: true,
+ imports: [ThemedTestThemeableComponent],
+})
+export class UsageComponent {
+}
+```
+
+
+
diff --git a/karma.conf.js b/karma.conf.js
index 8418312b1ab..f96558bfaff 100644
--- a/karma.conf.js
+++ b/karma.conf.js
@@ -15,7 +15,10 @@ module.exports = function (config) {
],
client: {
clearContext: false, // leave Jasmine Spec Runner output visible in browser
- captureConsole: false
+ captureConsole: false,
+ jasmine: {
+ failSpecWithNoExpectations: true
+ }
},
coverageIstanbulReporter: {
dir: require('path').join(__dirname, './coverage/dspace-angular'),
diff --git a/lint/.gitignore b/lint/.gitignore
new file mode 100644
index 00000000000..0d22081b3bc
--- /dev/null
+++ b/lint/.gitignore
@@ -0,0 +1,3 @@
+/dist/
+/coverage/
+/node-modules/
diff --git a/lint/README.md b/lint/README.md
new file mode 100644
index 00000000000..7251a35c06a
--- /dev/null
+++ b/lint/README.md
@@ -0,0 +1,50 @@
+# DSpace ESLint plugins
+
+Custom ESLint rules for DSpace Angular peculiarities.
+
+## Usage
+
+These plugins are included with the rest of our ESLint configuration in [.eslintc.json](../.eslintrc.json). Individual rules can be configured or disabled there, like usual.
+- In order for the new rules to be picked up by your IDE, you should first run `yarn build:lint` to build the plugins.
+- This will also happen automatically each time `yarn lint` is run.
+
+## Documentation
+
+The rules are split up into plugins by language:
+- [TypeScript rules](../docs/lint/ts/index.md)
+- [HTML rules](../docs/lint/html/index.md)
+
+> Run `yarn docs:lint` to generate this documentation!
+
+## Developing
+
+### Overview
+
+- All rules are written in TypeScript and compiled into [`dist`](./dist)
+ - The plugins are linked into the main project dependencies from here
+ - These directories already contain the necessary `package.json` files to mark them as ESLint plugins
+- Rule source files are structured, so they can be imported all in one go
+ - Each rule must export the following:
+ - `Messages`: an Enum of error message IDs
+ - `info`: metadata about this rule (name, description, messages, options, ...)
+ - `rule`: the implementation of the rule
+ - `tests`: the tests for this rule, as a set of valid/invalid code snippets. These snippets are used as example in the documentation.
+ - New rules should be added to their plugin's `index.ts`
+- Some useful links
+ - [Developing ESLint plugins](https://eslint.org/docs/latest/extend/plugins)
+ - [Custom rules in typescript-eslint](https://typescript-eslint.io/developers/custom-rules)
+ - [Angular ESLint](https://github.com/angular-eslint/angular-eslint)
+
+### Parsing project metadata in advance ~ TypeScript AST
+
+While it is possible to retain persistent state between files during the linting process, it becomes quite complicated if the content of one file determines how we want to lint another file.
+Because the two files may be linted out of order, we may not know whether the first file is wrong before we pass by the second. This means that we cannot report or fix the issue, because the first file is already detached from the linting context.
+
+For example, we cannot consistently determine which components are themeable (i.e. have a `ThemedComponent` wrapper) while linting.
+To work around this issue, we construct a registry of themeable components _before_ linting anything.
+- We don't have a good way to hook into the ESLint parser at this time
+- Instead, we leverage the actual TypeScript AST parser
+ - Retrieve all `ThemedComponent` wrapper files by the pattern of their path (`themed-*.component.ts`)
+ - Determine the themed component they're linked to (by the actual type annotation/import path, since filenames are prone to errors)
+ - Store metadata describing these component pairs in a global registry that can be shared between rules
+- This only needs to happen once, and only takes a fraction of a second (for ~100 themeable components)
\ No newline at end of file
diff --git a/lint/dist/src/rules/html/package.json b/lint/dist/src/rules/html/package.json
new file mode 100644
index 00000000000..d3f310d23b9
--- /dev/null
+++ b/lint/dist/src/rules/html/package.json
@@ -0,0 +1,6 @@
+{
+ "name": "eslint-plugin-dspace-angular-html",
+ "version": "0.0.0",
+ "main": "./index.js",
+ "private": true
+}
diff --git a/lint/dist/src/rules/ts/package.json b/lint/dist/src/rules/ts/package.json
new file mode 100644
index 00000000000..f19e18756ac
--- /dev/null
+++ b/lint/dist/src/rules/ts/package.json
@@ -0,0 +1,6 @@
+{
+ "name": "eslint-plugin-dspace-angular-ts",
+ "version": "0.0.0",
+ "main": "./index.js",
+ "private": true
+}
diff --git a/lint/generate-docs.ts b/lint/generate-docs.ts
new file mode 100644
index 00000000000..fb2bf53fb58
--- /dev/null
+++ b/lint/generate-docs.ts
@@ -0,0 +1,85 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
+import {
+ existsSync,
+ mkdirSync,
+ readFileSync,
+ rmSync,
+ writeFileSync,
+} from 'fs';
+import { join } from 'path';
+
+import { default as htmlPlugin } from './src/rules/html';
+import { default as tsPlugin } from './src/rules/ts';
+
+const templates = new Map();
+
+function lazyEJS(path: string, data: object): string {
+ if (!templates.has(path)) {
+ templates.set(path, require('ejs').compile(readFileSync(path).toString()));
+ }
+
+ return templates.get(path)(data).replace(/\r\n/g, '\n');
+}
+
+const docsDir = join('docs', 'lint');
+const tsDir = join(docsDir, 'ts');
+const htmlDir = join(docsDir, 'html');
+
+if (existsSync(docsDir)) {
+ rmSync(docsDir, { recursive: true });
+}
+
+mkdirSync(join(tsDir, 'rules'), { recursive: true });
+mkdirSync(join(htmlDir, 'rules'), { recursive: true });
+
+function template(name: string): string {
+ return join('lint', 'src', 'util', 'templates', name);
+}
+
+// TypeScript docs
+writeFileSync(
+ join(tsDir, 'index.md'),
+ lazyEJS(template('index.ejs'), {
+ plugin: tsPlugin,
+ rules: tsPlugin.index.map(rule => rule.info),
+ }),
+);
+
+for (const rule of tsPlugin.index) {
+ writeFileSync(
+ join(tsDir, 'rules', rule.info.name + '.md'),
+ lazyEJS(template('rule.ejs'), {
+ plugin: tsPlugin,
+ rule: rule.info,
+ tests: rule.tests,
+ }),
+ );
+}
+
+// HTML docs
+writeFileSync(
+ join(htmlDir, 'index.md'),
+ lazyEJS(template('index.ejs'), {
+ plugin: htmlPlugin,
+ rules: htmlPlugin.index.map(rule => rule.info),
+ }),
+);
+
+for (const rule of htmlPlugin.index) {
+ writeFileSync(
+ join(htmlDir, 'rules', rule.info.name + '.md'),
+ lazyEJS(template('rule.ejs'), {
+ plugin: htmlPlugin,
+ rule: rule.info,
+ tests: rule.tests,
+ }),
+ );
+}
+
diff --git a/lint/jasmine.json b/lint/jasmine.json
new file mode 100644
index 00000000000..dfacd41a96c
--- /dev/null
+++ b/lint/jasmine.json
@@ -0,0 +1,7 @@
+{
+ "spec_files": ["**/*.spec.js"],
+ "spec_dir": "lint/dist/test",
+ "helpers": [
+ "./test/helpers.js"
+ ]
+}
diff --git a/lint/src/rules/html/index.ts b/lint/src/rules/html/index.ts
new file mode 100644
index 00000000000..3d425c3ad48
--- /dev/null
+++ b/lint/src/rules/html/index.ts
@@ -0,0 +1,25 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+/* eslint-disable import/no-namespace */
+import {
+ bundle,
+ RuleExports,
+} from '../../util/structure';
+import * as noDisabledAttributeOnButton from './no-disabled-attribute-on-button';
+import * as themedComponentUsages from './themed-component-usages';
+
+const index = [
+ themedComponentUsages,
+ noDisabledAttributeOnButton,
+
+] as unknown as RuleExports[];
+
+export = {
+ parser: require('@angular-eslint/template-parser'),
+ ...bundle('dspace-angular-html', 'HTML', index),
+};
diff --git a/lint/src/rules/html/no-disabled-attribute-on-button.ts b/lint/src/rules/html/no-disabled-attribute-on-button.ts
new file mode 100644
index 00000000000..bf1a72d70d0
--- /dev/null
+++ b/lint/src/rules/html/no-disabled-attribute-on-button.ts
@@ -0,0 +1,147 @@
+import {
+ TmplAstBoundAttribute,
+ TmplAstTextAttribute,
+} from '@angular-eslint/bundled-angular-compiler';
+import { TemplateParserServices } from '@angular-eslint/utils';
+import {
+ ESLintUtils,
+ TSESLint,
+} from '@typescript-eslint/utils';
+
+import {
+ DSpaceESLintRuleInfo,
+ NamedTests,
+} from '../../util/structure';
+import { getSourceCode } from '../../util/typescript';
+
+export enum Message {
+ USE_DSBTN_DISABLED = 'mustUseDsBtnDisabled',
+}
+
+export const info = {
+ name: 'no-disabled-attribute-on-button',
+ meta: {
+ docs: {
+ description: `Buttons should use the \`dsBtnDisabled\` directive instead of the HTML \`disabled\` attribute.
+ This should be done to ensure that users with a screen reader are able to understand that the a button button is present, and that it is disabled.
+ The native html disabled attribute does not allow users to navigate to the button by keyboard, and thus they have no way of knowing that the button is present.`,
+ },
+ type: 'problem',
+ fixable: 'code',
+ schema: [],
+ messages: {
+ [Message.USE_DSBTN_DISABLED]: 'Buttons should use the `dsBtnDisabled` directive instead of the `disabled` attribute.',
+ },
+ },
+ defaultOptions: [],
+} as DSpaceESLintRuleInfo;
+
+export const rule = ESLintUtils.RuleCreator.withoutDocs({
+ ...info,
+ create(context: TSESLint.RuleContext) {
+ const parserServices = getSourceCode(context).parserServices as TemplateParserServices;
+
+ /**
+ * Some dynamic angular inputs will have disabled as name because of how Angular handles this internally (e.g [class.disabled]="isDisabled")
+ * But these aren't actually the disabled attribute we're looking for, we can determine this by checking the details of the keySpan
+ */
+ function isOtherAttributeDisabled(node: TmplAstBoundAttribute | TmplAstTextAttribute): boolean {
+ // if the details are not null, and the details are not 'disabled', then it's not the disabled attribute we're looking for
+ return node.keySpan?.details !== null && node.keySpan?.details !== 'disabled';
+ }
+
+ /**
+ * Replace the disabled text with [dsBtnDisabled] in the template
+ */
+ function replaceDisabledText(text: string ): string {
+ const hasBrackets = text.includes('[') && text.includes(']');
+ const newDisabledText = hasBrackets ? 'dsBtnDisabled' : '[dsBtnDisabled]="true"';
+ return text.replace('disabled', newDisabledText);
+ }
+
+ function inputIsChildOfButton(node: any): boolean {
+ return (node.parent?.tagName === 'button' || node.parent?.name === 'button');
+ }
+
+ function reportAndFix(node: TmplAstBoundAttribute | TmplAstTextAttribute) {
+ if (!inputIsChildOfButton(node) || isOtherAttributeDisabled(node)) {
+ return;
+ }
+
+ const sourceSpan = node.sourceSpan;
+ context.report({
+ messageId: Message.USE_DSBTN_DISABLED,
+ loc: parserServices.convertNodeSourceSpanToLoc(sourceSpan),
+ fix(fixer) {
+ const templateText = sourceSpan.start.file.content;
+ const disabledText = templateText.slice(sourceSpan.start.offset, sourceSpan.end.offset);
+ const newText = replaceDisabledText(disabledText);
+ return fixer.replaceTextRange([sourceSpan.start.offset, sourceSpan.end.offset], newText);
+ },
+ });
+ }
+
+ return {
+ 'BoundAttribute[name="disabled"]'(node: TmplAstBoundAttribute) {
+ reportAndFix(node);
+ },
+ 'TextAttribute[name="disabled"]'(node: TmplAstTextAttribute) {
+ reportAndFix(node);
+ },
+ };
+ },
+});
+
+export const tests = {
+ plugin: info.name,
+ valid: [
+ {
+ name: 'should use [dsBtnDisabled] in HTML templates',
+ code: `
+
+ `,
+ },
+ {
+ name: 'disabled attribute is still valid on non-button elements',
+ code: `
+
+ `,
+ },
+ {
+ name: '[disabled] attribute is still valid on non-button elements',
+ code: `
+
+ `,
+ },
+ {
+ name: 'angular dynamic attributes that use disabled are still valid',
+ code: `
+
+ `,
+ },
+ ],
+ invalid: [
+ {
+ name: 'should not use disabled attribute in HTML templates',
+ code: `
+
+ `,
+ errors: [{ messageId: Message.USE_DSBTN_DISABLED }],
+ output: `
+
+ `,
+ },
+ {
+ name: 'should not use [disabled] attribute in HTML templates',
+ code: `
+
+ `,
+ errors: [{ messageId: Message.USE_DSBTN_DISABLED }],
+ output: `
+
+ `,
+ },
+ ],
+} as NamedTests;
+
+export default rule;
diff --git a/lint/src/rules/html/themed-component-usages.ts b/lint/src/rules/html/themed-component-usages.ts
new file mode 100644
index 00000000000..e907285dbca
--- /dev/null
+++ b/lint/src/rules/html/themed-component-usages.ts
@@ -0,0 +1,189 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { TmplAstElement } from '@angular-eslint/bundled-angular-compiler';
+import { TemplateParserServices } from '@angular-eslint/utils';
+import { ESLintUtils } from '@typescript-eslint/utils';
+import { RuleContext } from '@typescript-eslint/utils/ts-eslint';
+
+import { fixture } from '../../../test/fixture';
+import {
+ DSpaceESLintRuleInfo,
+ NamedTests,
+} from '../../util/structure';
+import {
+ DISALLOWED_THEME_SELECTORS,
+ fixSelectors,
+} from '../../util/theme-support';
+import {
+ getFilename,
+ getSourceCode,
+} from '../../util/typescript';
+
+export enum Message {
+ WRONG_SELECTOR = 'mustUseThemedWrapperSelector',
+}
+
+export const info = {
+ name: 'themed-component-usages',
+ meta: {
+ docs: {
+ description: `Themeable components should be used via the selector of their \`ThemedComponent\` wrapper class
+
+This ensures that custom themes can correctly override _all_ instances of this component.
+The only exception to this rule are unit tests, where we may want to use the base component in order to keep the test setup simple.
+ `,
+ },
+ type: 'problem',
+ fixable: 'code',
+ schema: [],
+ messages: {
+ [Message.WRONG_SELECTOR]: 'Themeable components should be used via their ThemedComponent wrapper\'s selector',
+ },
+ },
+ defaultOptions: [],
+} as DSpaceESLintRuleInfo;
+
+export const rule = ESLintUtils.RuleCreator.withoutDocs({
+ ...info,
+ create(context: RuleContext) {
+ if (getFilename(context).includes('.spec.ts')) {
+ // skip inline templates in unit tests
+ return {};
+ }
+
+ const parserServices = getSourceCode(context).parserServices as TemplateParserServices;
+
+ return {
+ [`Element$1[name = /^${DISALLOWED_THEME_SELECTORS}/]`](node: TmplAstElement) {
+ const { startSourceSpan, endSourceSpan } = node;
+ const openStart = startSourceSpan.start.offset as number;
+
+ context.report({
+ messageId: Message.WRONG_SELECTOR,
+ loc: parserServices.convertNodeSourceSpanToLoc(startSourceSpan),
+ fix(fixer) {
+ const oldSelector = node.name;
+ const newSelector = fixSelectors(oldSelector);
+
+ const ops = [
+ fixer.replaceTextRange([openStart + 1, openStart + 1 + oldSelector.length], newSelector),
+ ];
+
+ // make sure we don't mangle self-closing tags
+ if (endSourceSpan !== null && startSourceSpan.end.offset !== endSourceSpan.end.offset) {
+ const closeStart = endSourceSpan.start.offset as number;
+ const closeEnd = endSourceSpan.end.offset as number;
+
+ ops.push(fixer.replaceTextRange([closeStart + 2, closeEnd - 1], newSelector));
+ }
+
+ return ops;
+ },
+ });
+ },
+ };
+ },
+});
+
+export const tests = {
+ plugin: info.name,
+ valid: [
+ {
+ name: 'use no-prefix selectors in HTML templates',
+ code: `
+
+
+
+ `,
+ },
+ {
+ name: 'use no-prefix selectors in TypeScript templates',
+ code: `
+@Component({
+ template: ''
+})
+class Test {
+}
+ `,
+ },
+ {
+ name: 'use no-prefix selectors in TypeScript test templates',
+ filename: fixture('src/test.spec.ts'),
+ code: `
+@Component({
+ template: ''
+})
+class Test {
+}
+ `,
+ },
+ {
+ name: 'base selectors are also allowed in TypeScript test templates',
+ filename: fixture('src/test.spec.ts'),
+ code: `
+@Component({
+ template: ''
+})
+class Test {
+}
+ `,
+ },
+ ],
+ invalid: [
+ {
+ name: 'themed override selectors are not allowed in HTML templates',
+ code: `
+
+
+
+ `,
+ errors: [
+ {
+ messageId: Message.WRONG_SELECTOR,
+ },
+ {
+ messageId: Message.WRONG_SELECTOR,
+ },
+ {
+ messageId: Message.WRONG_SELECTOR,
+ },
+ ],
+ output: `
+
+
+
+ `,
+ },
+ {
+ name: 'base selectors are not allowed in HTML templates',
+ code: `
+
+
+
+ `,
+ errors: [
+ {
+ messageId: Message.WRONG_SELECTOR,
+ },
+ {
+ messageId: Message.WRONG_SELECTOR,
+ },
+ {
+ messageId: Message.WRONG_SELECTOR,
+ },
+ ],
+ output: `
+
+
+
+ `,
+ },
+ ],
+} as NamedTests;
+
+export default rule;
diff --git a/lint/src/rules/ts/index.ts b/lint/src/rules/ts/index.ts
new file mode 100644
index 00000000000..a7fdfe41efe
--- /dev/null
+++ b/lint/src/rules/ts/index.ts
@@ -0,0 +1,25 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import {
+ bundle,
+ RuleExports,
+} from '../../util/structure';
+/* eslint-disable import/no-namespace */
+import * as themedComponentClasses from './themed-component-classes';
+import * as themedComponentSelectors from './themed-component-selectors';
+import * as themedComponentUsages from './themed-component-usages';
+
+const index = [
+ themedComponentClasses,
+ themedComponentSelectors,
+ themedComponentUsages,
+] as unknown as RuleExports[];
+
+export = {
+ ...bundle('dspace-angular-ts', 'TypeScript', index),
+};
diff --git a/lint/src/rules/ts/themed-component-classes.ts b/lint/src/rules/ts/themed-component-classes.ts
new file mode 100644
index 00000000000..527655adfa4
--- /dev/null
+++ b/lint/src/rules/ts/themed-component-classes.ts
@@ -0,0 +1,382 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import {
+ ESLintUtils,
+ TSESTree,
+} from '@typescript-eslint/utils';
+import { RuleContext } from '@typescript-eslint/utils/ts-eslint';
+
+import { fixture } from '../../../test/fixture';
+import {
+ getComponentImportNode,
+ getComponentInitializer,
+ getComponentStandaloneNode,
+} from '../../util/angular';
+import { appendObjectProperties } from '../../util/fix';
+import { DSpaceESLintRuleInfo } from '../../util/structure';
+import {
+ getBaseComponentClassName,
+ inThemedComponentOverrideFile,
+ isThemeableComponent,
+ isThemedComponentWrapper,
+} from '../../util/theme-support';
+import { getFilename } from '../../util/typescript';
+
+export enum Message {
+ NOT_STANDALONE = 'mustBeStandalone',
+ NOT_STANDALONE_IMPORTS_BASE = 'mustBeStandaloneAndImportBase',
+ WRAPPER_IMPORTS_BASE = 'wrapperShouldImportBase',
+}
+
+export const info = {
+ name: 'themed-component-classes',
+ meta: {
+ docs: {
+ description: `Formatting rules for themeable component classes
+
+- All themeable components must be standalone.
+- The base component must always be imported in the \`ThemedComponent\` wrapper. This ensures that it is always sufficient to import just the wrapper whenever we use the component.
+ `,
+ },
+ type: 'problem',
+ fixable: 'code',
+ schema: [],
+ messages: {
+ [Message.NOT_STANDALONE]: 'Themeable components must be standalone',
+ [Message.NOT_STANDALONE_IMPORTS_BASE]: 'Themeable component wrapper classes must be standalone and import the base class',
+ [Message.WRAPPER_IMPORTS_BASE]: 'Themed component wrapper classes must only import the base class',
+ },
+ },
+ defaultOptions: [],
+} as DSpaceESLintRuleInfo;
+
+export const rule = ESLintUtils.RuleCreator.withoutDocs({
+ ...info,
+ create(context: RuleContext) {
+ const filename = getFilename(context);
+
+ if (filename.endsWith('.spec.ts')) {
+ return {};
+ }
+
+ function enforceStandalone(decoratorNode: TSESTree.Decorator, withBaseImport = false) {
+ const standaloneNode = getComponentStandaloneNode(decoratorNode);
+
+ if (standaloneNode === undefined) {
+ // We may need to add these properties in one go
+ if (!withBaseImport) {
+ context.report({
+ messageId: Message.NOT_STANDALONE,
+ node: decoratorNode,
+ fix(fixer) {
+ const initializer = getComponentInitializer(decoratorNode);
+ return appendObjectProperties(context, fixer, initializer, ['standalone: true']);
+ },
+ });
+ }
+ } else if (!standaloneNode.value) {
+ context.report({
+ messageId: Message.NOT_STANDALONE,
+ node: standaloneNode,
+ fix(fixer) {
+ return fixer.replaceText(standaloneNode, 'true');
+ },
+ });
+ }
+
+ if (withBaseImport) {
+ const baseClass = getBaseComponentClassName(decoratorNode);
+
+ if (baseClass === undefined) {
+ return;
+ }
+
+ const importsNode = getComponentImportNode(decoratorNode);
+
+ if (importsNode === undefined) {
+ if (standaloneNode === undefined) {
+ context.report({
+ messageId: Message.NOT_STANDALONE_IMPORTS_BASE,
+ node: decoratorNode,
+ fix(fixer) {
+ const initializer = getComponentInitializer(decoratorNode);
+ return appendObjectProperties(context, fixer, initializer, ['standalone: true', `imports: [${baseClass}]`]);
+ },
+ });
+ } else {
+ context.report({
+ messageId: Message.WRAPPER_IMPORTS_BASE,
+ node: decoratorNode,
+ fix(fixer) {
+ const initializer = getComponentInitializer(decoratorNode);
+ return appendObjectProperties(context, fixer, initializer, [`imports: [${baseClass}]`]);
+ },
+ });
+ }
+ } else {
+ // If we have an imports node, standalone: true will be enforced by another rule
+
+ const imports = importsNode.elements.map(e => (e as TSESTree.Identifier).name);
+
+ if (!imports.includes(baseClass) || imports.length > 1) {
+ // The wrapper should _only_ import the base component
+ context.report({
+ messageId: Message.WRAPPER_IMPORTS_BASE,
+ node: importsNode,
+ fix(fixer) {
+ // todo: this may leave unused imports, but that's better than mangling things
+ return fixer.replaceText(importsNode, `[${baseClass}]`);
+ },
+ });
+ }
+ }
+ }
+ }
+
+ return {
+ 'ClassDeclaration > Decorator[expression.callee.name = "Component"]'(node: TSESTree.Decorator) {
+ const classNode = node.parent as TSESTree.ClassDeclaration;
+ const className = classNode.id?.name;
+
+ if (className === undefined) {
+ return;
+ }
+
+ if (isThemedComponentWrapper(node)) {
+ enforceStandalone(node, true);
+ } else if (inThemedComponentOverrideFile(filename)) {
+ enforceStandalone(node);
+ } else if (isThemeableComponent(className)) {
+ enforceStandalone(node);
+ }
+ },
+ };
+ },
+});
+
+export const tests = {
+ plugin: info.name,
+ valid: [
+ {
+ name: 'Regular non-themeable component',
+ code: `
+@Component({
+ selector: 'ds-something',
+ standalone: true,
+})
+class Something {
+}
+ `,
+ },
+ {
+ name: 'Base component',
+ code: `
+@Component({
+ selector: 'ds-base-test-themable',
+ standalone: true,
+})
+class TestThemeableTomponent {
+}
+ `,
+ },
+ {
+ name: 'Wrapper component',
+ filename: fixture('src/app/test/themed-test-themeable.component.ts'),
+ code: `
+@Component({
+ selector: 'ds-test-themable',
+ standalone: true,
+ imports: [
+ TestThemeableComponent,
+ ],
+})
+class ThemedTestThemeableTomponent extends ThemedComponent {
+}
+ `,
+ },
+ {
+ name: 'Override component',
+ filename: fixture('src/themes/test/app/test/test-themeable.component.ts'),
+ code: `
+@Component({
+ selector: 'ds-themed-test-themable',
+ standalone: true,
+})
+class Override extends BaseComponent {
+}
+ `,
+ },
+ ],
+ invalid: [
+ {
+ name: 'Base component must be standalone',
+ code: `
+@Component({
+ selector: 'ds-base-test-themable',
+})
+class TestThemeableComponent {
+}
+ `,
+ errors:[
+ {
+ messageId: Message.NOT_STANDALONE,
+ },
+ ],
+ output: `
+@Component({
+ selector: 'ds-base-test-themable',
+ standalone: true,
+})
+class TestThemeableComponent {
+}
+ `,
+ },
+ {
+ name: 'Wrapper component must be standalone and import base component',
+ filename: fixture('src/app/test/themed-test-themeable.component.ts'),
+ code: `
+@Component({
+ selector: 'ds-test-themable',
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+ `,
+ errors:[
+ {
+ messageId: Message.NOT_STANDALONE_IMPORTS_BASE,
+ },
+ ],
+ output: `
+@Component({
+ selector: 'ds-test-themable',
+ standalone: true,
+ imports: [TestThemeableComponent],
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+ `,
+ },
+
+ {
+ name: 'Wrapper component must import base component (array present but empty)',
+ filename: fixture('src/app/test/themed-test-themeable.component.ts'),
+ code: `
+@Component({
+ selector: 'ds-test-themable',
+ standalone: true,
+ imports: [],
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+ `,
+ errors:[
+ {
+ messageId: Message.WRAPPER_IMPORTS_BASE,
+ },
+ ],
+ output: `
+@Component({
+ selector: 'ds-test-themable',
+ standalone: true,
+ imports: [TestThemeableComponent],
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+ `,
+ },
+ {
+ name: 'Wrapper component must import base component (array is wrong)',
+ filename: fixture('src/app/test/themed-test-themeable.component.ts'),
+ code: `
+import { SomethingElse } from './somewhere-else';
+
+@Component({
+ selector: 'ds-test-themable',
+ standalone: true,
+ imports: [
+ SomethingElse,
+ ],
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+ `,
+ errors:[
+ {
+ messageId: Message.WRAPPER_IMPORTS_BASE,
+ },
+ ],
+ output: `
+import { SomethingElse } from './somewhere-else';
+
+@Component({
+ selector: 'ds-test-themable',
+ standalone: true,
+ imports: [TestThemeableComponent],
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+ `,
+ }, {
+ name: 'Wrapper component must import base component (array is wrong)',
+ filename: fixture('src/app/test/themed-test-themeable.component.ts'),
+ code: `
+import { Something, SomethingElse } from './somewhere-else';
+
+@Component({
+ selector: 'ds-test-themable',
+ standalone: true,
+ imports: [
+ SomethingElse,
+ ],
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+ `,
+ errors:[
+ {
+ messageId: Message.WRAPPER_IMPORTS_BASE,
+ },
+ ],
+ output: `
+import { Something, SomethingElse } from './somewhere-else';
+
+@Component({
+ selector: 'ds-test-themable',
+ standalone: true,
+ imports: [TestThemeableComponent],
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+ `,
+ },
+ {
+ name: 'Override component must be standalone',
+ filename: fixture('src/themes/test/app/test/test-themeable.component.ts'),
+ code: `
+@Component({
+ selector: 'ds-themed-test-themable',
+})
+class Override extends BaseComponent {
+}
+ `,
+ errors:[
+ {
+ messageId: Message.NOT_STANDALONE,
+ },
+ ],
+ output: `
+@Component({
+ selector: 'ds-themed-test-themable',
+ standalone: true,
+})
+class Override extends BaseComponent {
+}
+ `,
+ },
+ ],
+};
diff --git a/lint/src/rules/ts/themed-component-selectors.ts b/lint/src/rules/ts/themed-component-selectors.ts
new file mode 100644
index 00000000000..c27fd66d662
--- /dev/null
+++ b/lint/src/rules/ts/themed-component-selectors.ts
@@ -0,0 +1,257 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import {
+ ESLintUtils,
+ TSESTree,
+} from '@typescript-eslint/utils';
+import { RuleContext } from '@typescript-eslint/utils/ts-eslint';
+
+import { fixture } from '../../../test/fixture';
+import { getComponentSelectorNode } from '../../util/angular';
+import { stringLiteral } from '../../util/misc';
+import { DSpaceESLintRuleInfo } from '../../util/structure';
+import {
+ inThemedComponentOverrideFile,
+ isThemeableComponent,
+ isThemedComponentWrapper,
+} from '../../util/theme-support';
+import { getFilename } from '../../util/typescript';
+
+export enum Message {
+ BASE = 'wrongSelectorUnthemedComponent',
+ WRAPPER = 'wrongSelectorThemedComponentWrapper',
+ THEMED = 'wrongSelectorThemedComponentOverride',
+}
+
+export const info = {
+ name: 'themed-component-selectors',
+ meta: {
+ docs: {
+ description: `Themeable component selectors should follow the DSpace convention
+
+Each themeable component is comprised of a base component, a wrapper component and any number of themed components
+- Base components should have a selector starting with \`ds-base-\`
+- Themed components should have a selector starting with \`ds-themed-\`
+- Wrapper components should have a selector starting with \`ds-\`, but not \`ds-base-\` or \`ds-themed-\`
+ - This is the regular DSpace selector prefix
+ - **When making a regular component themeable, its selector prefix should be changed to \`ds-base-\`, and the new wrapper's component should reuse the previous selector**
+
+Unit tests are exempt from this rule, because they may redefine components using the same class name as other themeable components elsewhere in the source.
+ `,
+ },
+ type: 'problem',
+ schema: [],
+ fixable: 'code',
+ messages: {
+ [Message.BASE]: 'Unthemed version of themeable component should have a selector starting with \'ds-base-\'',
+ [Message.WRAPPER]: 'Themed component wrapper of themeable component shouldn\'t have a selector starting with \'ds-themed-\'',
+ [Message.THEMED]: 'Theme override of themeable component should have a selector starting with \'ds-themed-\'',
+ },
+ },
+ defaultOptions: [],
+} as DSpaceESLintRuleInfo;
+
+export const rule = ESLintUtils.RuleCreator.withoutDocs({
+ ...info,
+ create(context: RuleContext) {
+ const filename = getFilename(context);
+
+ if (filename.endsWith('.spec.ts')) {
+ return {};
+ }
+
+ function enforceWrapperSelector(selectorNode: TSESTree.StringLiteral) {
+ if (selectorNode?.value.startsWith('ds-themed-')) {
+ context.report({
+ messageId: Message.WRAPPER,
+ node: selectorNode,
+ fix(fixer) {
+ return fixer.replaceText(selectorNode, stringLiteral(selectorNode.value.replace('ds-themed-', 'ds-')));
+ },
+ });
+ }
+ }
+
+ function enforceBaseSelector(selectorNode: TSESTree.StringLiteral) {
+ if (!selectorNode?.value.startsWith('ds-base-')) {
+ context.report({
+ messageId: Message.BASE,
+ node: selectorNode,
+ fix(fixer) {
+ return fixer.replaceText(selectorNode, stringLiteral(selectorNode.value.replace('ds-', 'ds-base-')));
+ },
+ });
+ }
+ }
+
+ function enforceThemedSelector(selectorNode: TSESTree.StringLiteral) {
+ if (!selectorNode?.value.startsWith('ds-themed-')) {
+ context.report({
+ messageId: Message.THEMED,
+ node: selectorNode,
+ fix(fixer) {
+ return fixer.replaceText(selectorNode, stringLiteral(selectorNode.value.replace('ds-', 'ds-themed-')));
+ },
+ });
+ }
+ }
+
+ return {
+ 'ClassDeclaration > Decorator[expression.callee.name = "Component"]'(node: TSESTree.Decorator) {
+ const selectorNode = getComponentSelectorNode(node);
+
+ if (selectorNode === undefined) {
+ return;
+ }
+
+ const selector = selectorNode?.value;
+ const classNode = node.parent as TSESTree.ClassDeclaration;
+ const className = classNode.id?.name;
+
+ if (selector === undefined || className === undefined) {
+ return;
+ }
+
+ if (isThemedComponentWrapper(node)) {
+ enforceWrapperSelector(selectorNode);
+ } else if (inThemedComponentOverrideFile(filename)) {
+ enforceThemedSelector(selectorNode);
+ } else if (isThemeableComponent(className)) {
+ enforceBaseSelector(selectorNode);
+ }
+ },
+ };
+ },
+});
+
+export const tests = {
+ plugin: info.name,
+ valid: [
+ {
+ name: 'Regular non-themeable component selector',
+ code: `
+@Component({
+ selector: 'ds-something',
+})
+class Something {
+}
+ `,
+ },
+ {
+ name: 'Themeable component selector should replace the original version, unthemed version should be changed to ds-base-',
+ code: `
+@Component({
+ selector: 'ds-base-something',
+})
+class Something {
+}
+
+@Component({
+ selector: 'ds-something',
+})
+class ThemedSomething extends ThemedComponent {
+}
+
+@Component({
+ selector: 'ds-themed-something',
+})
+class OverrideSomething extends Something {
+}
+ `,
+ },
+ {
+ name: 'Other themed component wrappers should not interfere',
+ code: `
+@Component({
+ selector: 'ds-something',
+})
+class Something {
+}
+
+@Component({
+ selector: 'ds-something-else',
+})
+class ThemedSomethingElse extends ThemedComponent {
+}
+ `,
+ },
+ ],
+ invalid: [
+ {
+ name: 'Wrong selector for base component',
+ filename: fixture('src/app/test/test-themeable.component.ts'),
+ code: `
+@Component({
+ selector: 'ds-something',
+})
+class TestThemeableComponent {
+}
+ `,
+ errors: [
+ {
+ messageId: Message.BASE,
+ },
+ ],
+ output: `
+@Component({
+ selector: 'ds-base-something',
+})
+class TestThemeableComponent {
+}
+ `,
+ },
+ {
+ name: 'Wrong selector for wrapper component',
+ filename: fixture('src/app/test/themed-test-themeable.component.ts'),
+ code: `
+@Component({
+ selector: 'ds-themed-something',
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+ `,
+ errors: [
+ {
+ messageId: Message.WRAPPER,
+ },
+ ],
+ output: `
+@Component({
+ selector: 'ds-something',
+})
+class ThemedTestThemeableComponent extends ThemedComponent {
+}
+ `,
+ },
+ {
+ name: 'Wrong selector for theme override',
+ filename: fixture('src/themes/test/app/test/test-themeable.component.ts'),
+ code: `
+@Component({
+ selector: 'ds-something',
+})
+class TestThememeableComponent extends BaseComponent {
+}
+ `,
+ errors: [
+ {
+ messageId: Message.THEMED,
+ },
+ ],
+ output: `
+@Component({
+ selector: 'ds-themed-something',
+})
+class TestThememeableComponent extends BaseComponent {
+}
+ `,
+ },
+ ],
+};
+
+export default rule;
diff --git a/lint/src/rules/ts/themed-component-usages.ts b/lint/src/rules/ts/themed-component-usages.ts
new file mode 100644
index 00000000000..83fe6f8ea89
--- /dev/null
+++ b/lint/src/rules/ts/themed-component-usages.ts
@@ -0,0 +1,502 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import {
+ ESLintUtils,
+ TSESTree,
+} from '@typescript-eslint/utils';
+import { RuleContext } from '@typescript-eslint/utils/ts-eslint';
+
+import { fixture } from '../../../test/fixture';
+import {
+ removeWithCommas,
+ replaceOrRemoveArrayIdentifier,
+} from '../../util/fix';
+import { DSpaceESLintRuleInfo } from '../../util/structure';
+import {
+ allThemeableComponents,
+ DISALLOWED_THEME_SELECTORS,
+ fixSelectors,
+ getThemeableComponentByBaseClass,
+ isAllowedUnthemedUsage,
+} from '../../util/theme-support';
+import {
+ findImportSpecifier,
+ findUsages,
+ findUsagesByName,
+ getFilename,
+ relativePath,
+} from '../../util/typescript';
+
+export enum Message {
+ WRONG_CLASS = 'mustUseThemedWrapperClass',
+ WRONG_IMPORT = 'mustImportThemedWrapper',
+ WRONG_SELECTOR = 'mustUseThemedWrapperSelector',
+ BASE_IN_MODULE = 'baseComponentNotNeededInModule',
+}
+
+export const info = {
+ name: 'themed-component-usages',
+ meta: {
+ docs: {
+ description: `Themeable components should be used via their \`ThemedComponent\` wrapper class
+
+This ensures that custom themes can correctly override _all_ instances of this component.
+There are a few exceptions where the base class can still be used:
+- Class declaration expressions (otherwise we can't declare, extend or override the class in the first place)
+- Angular modules (except for routing modules)
+- Angular \`@ViewChild\` decorators
+- Type annotations
+ `,
+ },
+ type: 'problem',
+ schema: [],
+ fixable: 'code',
+ messages: {
+ [Message.WRONG_CLASS]: 'Themeable components should be used via their ThemedComponent wrapper',
+ [Message.WRONG_IMPORT]: 'Themeable components should be used via their ThemedComponent wrapper',
+ [Message.WRONG_SELECTOR]: 'Themeable components should be used via their ThemedComponent wrapper',
+ [Message.BASE_IN_MODULE]: 'Base themeable components shouldn\'t be declared in modules',
+ },
+ },
+ defaultOptions: [],
+} as DSpaceESLintRuleInfo;
+
+export const rule = ESLintUtils.RuleCreator.withoutDocs({
+ ...info,
+ create(context: RuleContext) {
+ const filename = getFilename(context);
+
+ function handleUnthemedUsagesInTypescript(node: TSESTree.Identifier) {
+ if (isAllowedUnthemedUsage(node)) {
+ return;
+ }
+
+ const entry = getThemeableComponentByBaseClass(node.name);
+
+ if (entry === undefined) {
+ // this should never happen
+ throw new Error(`No such themeable component in registry: '${node.name}'`);
+ }
+
+ context.report({
+ messageId: Message.WRONG_CLASS,
+ node: node,
+ fix(fixer) {
+ if (node.parent.type === TSESTree.AST_NODE_TYPES.ArrayExpression) {
+ return replaceOrRemoveArrayIdentifier(context, fixer, node, entry.wrapperClass);
+ } else {
+ return fixer.replaceText(node, entry.wrapperClass);
+ }
+ },
+ });
+ }
+
+ function handleThemedSelectorQueriesInTests(node: TSESTree.Literal) {
+ context.report({
+ node,
+ messageId: Message.WRONG_SELECTOR,
+ fix(fixer){
+ const newSelector = fixSelectors(node.raw);
+ return fixer.replaceText(node, newSelector);
+ },
+ });
+ }
+
+ function handleUnthemedImportsInTypescript(specifierNode: TSESTree.ImportSpecifier) {
+ const allUsages = findUsages(context, specifierNode.local);
+ const badUsages = allUsages.filter(usage => !isAllowedUnthemedUsage(usage));
+
+ if (badUsages.length === 0) {
+ return;
+ }
+
+ const importedNode = specifierNode.imported;
+ const declarationNode = specifierNode.parent as TSESTree.ImportDeclaration;
+
+ const entry = getThemeableComponentByBaseClass(importedNode.name);
+ if (entry === undefined) {
+ // this should never happen
+ throw new Error(`No such themeable component in registry: '${importedNode.name}'`);
+ }
+
+ context.report({
+ messageId: Message.WRONG_IMPORT,
+ node: importedNode,
+ fix(fixer) {
+ const ops = [];
+
+ const wrapperImport = findImportSpecifier(context, entry.wrapperClass);
+
+ if (findUsagesByName(context, entry.wrapperClass).length === 0) {
+ // Wrapper is not present in this file, safe to add import
+
+ const newImportLine = `import { ${entry.wrapperClass} } from '${relativePath(filename, entry.wrapperPath)}';`;
+
+ if (declarationNode.specifiers.length === 1) {
+ if (allUsages.length === badUsages.length) {
+ ops.push(fixer.replaceText(declarationNode, newImportLine));
+ } else if (wrapperImport === undefined) {
+ ops.push(fixer.insertTextAfter(declarationNode, '\n' + newImportLine));
+ }
+ } else {
+ ops.push(...removeWithCommas(context, fixer, specifierNode));
+ if (wrapperImport === undefined) {
+ ops.push(fixer.insertTextAfter(declarationNode, '\n' + newImportLine));
+ }
+ }
+ } else {
+ // Wrapper already present in the file, remove import instead
+
+ if (allUsages.length === badUsages.length) {
+ if (declarationNode.specifiers.length === 1) {
+ // Make sure we remove the newline as well
+ ops.push(fixer.removeRange([declarationNode.range[0], declarationNode.range[1] + 1]));
+ } else {
+ ops.push(...removeWithCommas(context, fixer, specifierNode));
+ }
+ }
+ }
+
+ return ops;
+ },
+ });
+ }
+
+ // ignore tests and non-routing modules
+ if (filename.endsWith('.spec.ts')) {
+ return {
+ [`CallExpression[callee.object.name = "By"][callee.property.name = "css"] > Literal:first-child[value = /.*${DISALLOWED_THEME_SELECTORS}.*/]`]: handleThemedSelectorQueriesInTests,
+ };
+ } else if (filename.endsWith('.cy.ts')) {
+ return {
+ [`CallExpression[callee.object.name = "cy"][callee.property.name = "get"] > Literal:first-child[value = /.*${DISALLOWED_THEME_SELECTORS}.*/]`]: handleThemedSelectorQueriesInTests,
+ };
+ } else if (
+ filename.match(/(?!src\/themes\/).*(?!routing).module.ts$/)
+ || filename.match(/themed-.+\.component\.ts$/)
+ ) {
+ // do nothing
+ return {};
+ } else {
+ return allThemeableComponents().reduce(
+ (rules, entry) => {
+ return {
+ ...rules,
+ [`:not(:matches(ClassDeclaration, ImportSpecifier)) > Identifier[name = "${entry.baseClass}"]`]: handleUnthemedUsagesInTypescript,
+ [`ImportSpecifier[imported.name = "${entry.baseClass}"]`]: handleUnthemedImportsInTypescript,
+ };
+ }, {},
+ );
+ }
+
+ },
+});
+
+export const tests = {
+ plugin: info.name,
+ valid: [
+ {
+ name: 'allow wrapper class usages',
+ code: `
+import { ThemedTestThemeableComponent } from './app/test/themed-test-themeable.component';
+
+const config = {
+ a: ThemedTestThemeableComponent,
+ b: ChipsComponent,
+}
+ `,
+ },
+ {
+ name: 'allow base class in class declaration',
+ code: `
+export class TestThemeableComponent {
+}
+ `,
+ },
+ {
+ name: 'allow inheriting from base class',
+ code: `
+import { TestThemeableComponent } from './app/test/test-themeable.component';
+
+export class ThemedAdminSidebarComponent extends ThemedComponent {
+}
+ `,
+ },
+ {
+ name: 'allow base class in ViewChild',
+ code: `
+import { TestThemeableComponent } from './app/test/test-themeable.component';
+
+export class Something {
+ @ViewChild(TestThemeableComponent) test: TestThemeableComponent;
+}
+ `,
+ },
+ {
+ name: 'allow wrapper selectors in test queries',
+ filename: fixture('src/app/test/test.component.spec.ts'),
+ code: `
+By.css('ds-themeable');
+By.css('#test > ds-themeable > #nest');
+ `,
+ },
+ {
+ name: 'allow wrapper selectors in cypress queries',
+ filename: fixture('src/app/test/test.component.cy.ts'),
+ code: `
+By.css('ds-themeable');
+By.css('#test > ds-themeable > #nest');
+ `,
+ },
+ ],
+ invalid: [
+ {
+ name: 'disallow direct usages of base class',
+ code: `
+import { TestThemeableComponent } from './app/test/test-themeable.component';
+import { TestComponent } from './app/test/test.component';
+
+const config = {
+ a: TestThemeableComponent,
+ b: TestComponent,
+}
+ `,
+ errors: [
+ {
+ messageId: Message.WRONG_IMPORT,
+ },
+ {
+ messageId: Message.WRONG_CLASS,
+ },
+ ],
+ output: `
+import { ThemedTestThemeableComponent } from './app/test/themed-test-themeable.component';
+import { TestComponent } from './app/test/test.component';
+
+const config = {
+ a: ThemedTestThemeableComponent,
+ b: TestComponent,
+}
+ `,
+ },
+ {
+ name: 'disallow direct usages of base class, keep other imports',
+ code: `
+import { Something, TestThemeableComponent } from './app/test/test-themeable.component';
+import { TestComponent } from './app/test/test.component';
+
+const config = {
+ a: TestThemeableComponent,
+ b: TestComponent,
+ c: Something,
+}
+ `,
+ errors: [
+ {
+ messageId: Message.WRONG_IMPORT,
+ },
+ {
+ messageId: Message.WRONG_CLASS,
+ },
+ ],
+ output: `
+import { Something } from './app/test/test-themeable.component';
+import { ThemedTestThemeableComponent } from './app/test/themed-test-themeable.component';
+import { TestComponent } from './app/test/test.component';
+
+const config = {
+ a: ThemedTestThemeableComponent,
+ b: TestComponent,
+ c: Something,
+}
+ `,
+ },
+ {
+ name: 'handle array replacements correctly',
+ code: `
+const DECLARATIONS = [
+ Something,
+ TestThemeableComponent,
+ Something,
+ ThemedTestThemeableComponent,
+];
+ `,
+ errors: [
+ {
+ messageId: Message.WRONG_CLASS,
+ },
+ ],
+ output: `
+const DECLARATIONS = [
+ Something,
+ Something,
+ ThemedTestThemeableComponent,
+];
+ `,
+ },
+ {
+ name: 'disallow override selector in test queries',
+ filename: fixture('src/app/test/test.component.spec.ts'),
+ code: `
+By.css('ds-themed-themeable');
+By.css('#test > ds-themed-themeable > #nest');
+ `,
+ errors: [
+ {
+ messageId: Message.WRONG_SELECTOR,
+ },
+ {
+ messageId: Message.WRONG_SELECTOR,
+ },
+ ],
+ output: `
+By.css('ds-themeable');
+By.css('#test > ds-themeable > #nest');
+ `,
+ },
+ {
+ name: 'disallow base selector in test queries',
+ filename: fixture('src/app/test/test.component.spec.ts'),
+ code: `
+By.css('ds-base-themeable');
+By.css('#test > ds-base-themeable > #nest');
+ `,
+ errors: [
+ {
+ messageId: Message.WRONG_SELECTOR,
+ },
+ {
+ messageId: Message.WRONG_SELECTOR,
+ },
+ ],
+ output: `
+By.css('ds-themeable');
+By.css('#test > ds-themeable > #nest');
+ `,
+ },
+ {
+ name: 'disallow override selector in cypress queries',
+ filename: fixture('src/app/test/test.component.cy.ts'),
+ code: `
+cy.get('ds-themed-themeable');
+cy.get('#test > ds-themed-themeable > #nest');
+ `,
+ errors: [
+ {
+ messageId: Message.WRONG_SELECTOR,
+ },
+ {
+ messageId: Message.WRONG_SELECTOR,
+ },
+ ],
+ output: `
+cy.get('ds-themeable');
+cy.get('#test > ds-themeable > #nest');
+ `,
+ },
+ {
+ name: 'disallow base selector in cypress queries',
+ filename: fixture('src/app/test/test.component.cy.ts'),
+ code: `
+cy.get('ds-base-themeable');
+cy.get('#test > ds-base-themeable > #nest');
+ `,
+ errors: [
+ {
+ messageId: Message.WRONG_SELECTOR,
+ },
+ {
+ messageId: Message.WRONG_SELECTOR,
+ },
+ ],
+ output: `
+cy.get('ds-themeable');
+cy.get('#test > ds-themeable > #nest');
+ `,
+ },
+ {
+ name: 'edge case: unable to find usage node through usage token, but import is still flagged and fixed',
+ filename: fixture('src/themes/test/app/test/other-themeable.component.ts'),
+ code: `
+import { Component } from '@angular/core';
+
+import { Context } from './app/core/shared/context.model';
+import { TestThemeableComponent } from '../../../../app/test/test-themeable.component';
+
+@Component({
+ standalone: true,
+ imports: [TestThemeableComponent],
+})
+export class UsageComponent {
+}
+ `,
+ errors: [
+ {
+ messageId: Message.WRONG_IMPORT,
+ },
+ {
+ messageId: Message.WRONG_CLASS,
+ },
+ ],
+ output: `
+import { Component } from '@angular/core';
+
+import { Context } from './app/core/shared/context.model';
+import { ThemedTestThemeableComponent } from '../../../../app/test/themed-test-themeable.component';
+
+@Component({
+ standalone: true,
+ imports: [ThemedTestThemeableComponent],
+})
+export class UsageComponent {
+}
+ `,
+ },
+ {
+ name: 'edge case edge case: both are imported, only wrapper is retained',
+ filename: fixture('src/themes/test/app/test/other-themeable.component.ts'),
+ code: `
+import { Component } from '@angular/core';
+
+import { Context } from './app/core/shared/context.model';
+import { TestThemeableComponent } from '../../../../app/test/test-themeable.component';
+import { ThemedTestThemeableComponent } from '../../../../app/test/themed-test-themeable.component';
+
+@Component({
+ standalone: true,
+ imports: [TestThemeableComponent, ThemedTestThemeableComponent],
+})
+export class UsageComponent {
+}
+ `,
+ errors: [
+ {
+ messageId: Message.WRONG_IMPORT,
+ },
+ {
+ messageId: Message.WRONG_CLASS,
+ },
+ ],
+ output: `
+import { Component } from '@angular/core';
+
+import { Context } from './app/core/shared/context.model';
+import { ThemedTestThemeableComponent } from '../../../../app/test/themed-test-themeable.component';
+
+@Component({
+ standalone: true,
+ imports: [ThemedTestThemeableComponent],
+})
+export class UsageComponent {
+}
+ `,
+ },
+ ],
+};
+
+export default rule;
diff --git a/lint/src/util/angular.ts b/lint/src/util/angular.ts
new file mode 100644
index 00000000000..70ee903fb81
--- /dev/null
+++ b/lint/src/util/angular.ts
@@ -0,0 +1,83 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { TSESTree } from '@typescript-eslint/utils';
+
+import { getObjectPropertyNodeByName } from './typescript';
+
+export function getComponentSelectorNode(componentDecoratorNode: TSESTree.Decorator): TSESTree.StringLiteral | undefined {
+ const property = getComponentInitializerNodeByName(componentDecoratorNode, 'selector');
+
+ if (property !== undefined) {
+ // todo: support template literals as well
+ if (property.type === TSESTree.AST_NODE_TYPES.Literal && typeof property.value === 'string') {
+ return property as TSESTree.StringLiteral;
+ }
+ }
+
+ return undefined;
+}
+
+export function getComponentStandaloneNode(componentDecoratorNode: TSESTree.Decorator): TSESTree.BooleanLiteral | undefined {
+ const property = getComponentInitializerNodeByName(componentDecoratorNode, 'standalone');
+
+ if (property !== undefined) {
+ if (property.type === TSESTree.AST_NODE_TYPES.Literal && typeof property.value === 'boolean') {
+ return property as TSESTree.BooleanLiteral;
+ }
+ }
+
+ return undefined;
+}
+export function getComponentImportNode(componentDecoratorNode: TSESTree.Decorator): TSESTree.ArrayExpression | undefined {
+ const property = getComponentInitializerNodeByName(componentDecoratorNode, 'imports');
+
+ if (property !== undefined) {
+ if (property.type === TSESTree.AST_NODE_TYPES.ArrayExpression) {
+ return property as TSESTree.ArrayExpression;
+ }
+ }
+
+ return undefined;
+}
+
+export function getComponentClassName(decoratorNode: TSESTree.Decorator): string | undefined {
+ if (decoratorNode.parent.type !== TSESTree.AST_NODE_TYPES.ClassDeclaration) {
+ return undefined;
+ }
+
+ if (decoratorNode.parent.id?.type !== TSESTree.AST_NODE_TYPES.Identifier) {
+ return undefined;
+ }
+
+ return decoratorNode.parent.id.name;
+}
+
+export function getComponentSuperClassName(decoratorNode: TSESTree.Decorator): string | undefined {
+ if (decoratorNode.parent.type !== TSESTree.AST_NODE_TYPES.ClassDeclaration) {
+ return undefined;
+ }
+
+ if (decoratorNode.parent.superClass?.type !== TSESTree.AST_NODE_TYPES.Identifier) {
+ return undefined;
+ }
+
+ return decoratorNode.parent.superClass.name;
+}
+
+export function getComponentInitializer(componentDecoratorNode: TSESTree.Decorator): TSESTree.ObjectExpression {
+ return (componentDecoratorNode.expression as TSESTree.CallExpression).arguments[0] as TSESTree.ObjectExpression;
+}
+
+export function getComponentInitializerNodeByName(componentDecoratorNode: TSESTree.Decorator, name: string): TSESTree.Node | undefined {
+ const initializer = getComponentInitializer(componentDecoratorNode);
+ return getObjectPropertyNodeByName(initializer, name);
+}
+
+export function isPartOfViewChild(node: TSESTree.Identifier): boolean {
+ return (node.parent as any)?.callee?.name === 'ViewChild';
+}
diff --git a/lint/src/util/fix.ts b/lint/src/util/fix.ts
new file mode 100644
index 00000000000..10408cc316c
--- /dev/null
+++ b/lint/src/util/fix.ts
@@ -0,0 +1,125 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { TSESTree } from '@typescript-eslint/utils';
+import {
+ RuleContext,
+ RuleFix,
+ RuleFixer,
+} from '@typescript-eslint/utils/ts-eslint';
+
+import { getSourceCode } from './typescript';
+
+
+
+export function appendObjectProperties(context: RuleContext, fixer: RuleFixer, objectNode: TSESTree.ObjectExpression, properties: string[]): RuleFix {
+ // todo: may not handle empty objects too well
+ const lastProperty = objectNode.properties[objectNode.properties.length - 1];
+ const source = getSourceCode(context);
+ const nextToken = source.getTokenAfter(lastProperty);
+
+ // todo: newline & indentation are hardcoded for @Component({})
+ // todo: we're assuming that we need trailing commas, what if we don't?
+ const newPart = '\n' + properties.map(p => ` ${p},`).join('\n');
+
+ if (nextToken !== null && nextToken.value === ',') {
+ return fixer.insertTextAfter(nextToken, newPart);
+ } else {
+ return fixer.insertTextAfter(lastProperty, ',' + newPart);
+ }
+}
+
+export function appendArrayElement(context: RuleContext, fixer: RuleFixer, arrayNode: TSESTree.ArrayExpression, value: string): RuleFix {
+ const source = getSourceCode(context);
+
+ if (arrayNode.elements.length === 0) {
+ // This is the first element
+ const openArray = source.getTokenByRangeStart(arrayNode.range[0]);
+
+ if (openArray == null) {
+ throw new Error('Unexpected null token for opening square bracket');
+ }
+
+ // safe to assume the list is single-line
+ return fixer.insertTextAfter(openArray, `${value}`);
+ } else {
+ const lastElement = arrayNode.elements[arrayNode.elements.length - 1];
+
+ if (lastElement == null) {
+ throw new Error('Unexpected null node in array');
+ }
+
+ const nextToken = source.getTokenAfter(lastElement);
+
+ // todo: we don't know if the list is chopped or not, so we can't make any assumptions -- may produce output that will be flagged by other rules on the next run!
+ // todo: we're assuming that we need trailing commas, what if we don't?
+ if (nextToken !== null && nextToken.value === ',') {
+ return fixer.insertTextAfter(nextToken, ` ${value},`);
+ } else {
+ return fixer.insertTextAfter(lastElement, `, ${value},`);
+ }
+ }
+
+}
+
+export function isLast(elementNode: TSESTree.Node): boolean {
+ if (!elementNode.parent) {
+ return false;
+ }
+
+ let siblingNodes: (TSESTree.Node | null)[] = [null];
+ if (elementNode.parent.type === TSESTree.AST_NODE_TYPES.ArrayExpression) {
+ siblingNodes = elementNode.parent.elements;
+ } else if (elementNode.parent.type === TSESTree.AST_NODE_TYPES.ImportDeclaration) {
+ siblingNodes = elementNode.parent.specifiers;
+ }
+
+ return elementNode === siblingNodes[siblingNodes.length - 1];
+}
+
+export function removeWithCommas(context: RuleContext, fixer: RuleFixer, elementNode: TSESTree.Node): RuleFix[] {
+ const ops = [];
+
+ const source = getSourceCode(context);
+ let nextToken = source.getTokenAfter(elementNode);
+ let prevToken = source.getTokenBefore(elementNode);
+
+ if (nextToken !== null && prevToken !== null) {
+ if (nextToken.value === ',') {
+ nextToken = source.getTokenAfter(nextToken);
+ if (nextToken !== null) {
+ ops.push(fixer.removeRange([elementNode.range[0], nextToken.range[0]]));
+ }
+ }
+ if (isLast(elementNode) && prevToken.value === ',') {
+ prevToken = source.getTokenBefore(prevToken);
+ if (prevToken !== null) {
+ ops.push(fixer.removeRange([prevToken.range[1], elementNode.range[1]]));
+ }
+ }
+ } else if (nextToken !== null) {
+ ops.push(fixer.removeRange([elementNode.range[0], nextToken.range[0]]));
+ }
+
+ return ops;
+}
+
+export function replaceOrRemoveArrayIdentifier(context: RuleContext, fixer: RuleFixer, identifierNode: TSESTree.Identifier, newValue: string): RuleFix[] {
+ if (identifierNode.parent.type !== TSESTree.AST_NODE_TYPES.ArrayExpression) {
+ throw new Error('Parent node is not an array expression!');
+ }
+
+ const array = identifierNode.parent as TSESTree.ArrayExpression;
+
+ for (const element of array.elements) {
+ if (element !== null && element.type === TSESTree.AST_NODE_TYPES.Identifier && element.name === newValue) {
+ return removeWithCommas(context, fixer, identifierNode);
+ }
+ }
+
+ return [fixer.replaceText(identifierNode, newValue)];
+}
diff --git a/lint/src/util/misc.ts b/lint/src/util/misc.ts
new file mode 100644
index 00000000000..49cb60124e8
--- /dev/null
+++ b/lint/src/util/misc.ts
@@ -0,0 +1,28 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
+export function match(rangeA: number[], rangeB: number[]) {
+ return rangeA[0] === rangeB[0] && rangeA[1] === rangeB[1];
+}
+
+
+export function stringLiteral(value: string): string {
+ return `'${value}'`;
+}
+
+/**
+ * Transform Windows-style paths into Unix-style paths
+ */
+export function toUnixStylePath(path: string): string {
+ // note: we're assuming that none of the directory/file names contain '\' or '/' characters.
+ // using these characters in paths is very bad practice in general, so this should be a safe assumption.
+ if (path.includes('\\')) {
+ return path.replace(/^[A-Z]:\\/, '/').replaceAll('\\', '/');
+ }
+ return path;
+}
diff --git a/lint/src/util/structure.ts b/lint/src/util/structure.ts
new file mode 100644
index 00000000000..2e3aebd9ab4
--- /dev/null
+++ b/lint/src/util/structure.ts
@@ -0,0 +1,61 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import {
+ InvalidTestCase,
+ RuleMetaData,
+ RuleModule,
+ ValidTestCase,
+} from '@typescript-eslint/utils/ts-eslint';
+import { EnumType } from 'typescript';
+
+export type Meta = RuleMetaData;
+export type Valid = ValidTestCase;
+export type Invalid = InvalidTestCase;
+
+export interface DSpaceESLintRuleInfo {
+ name: string;
+ meta: Meta,
+ defaultOptions: unknown[],
+}
+
+export interface NamedTests {
+ plugin: string;
+ valid: Valid[];
+ invalid: Invalid[];
+}
+
+export interface RuleExports {
+ Message: EnumType,
+ info: DSpaceESLintRuleInfo,
+ rule: RuleModule,
+ tests: NamedTests,
+ default: unknown,
+}
+
+export interface PluginExports {
+ name: string,
+ language: string,
+ rules: Record,
+ index: RuleExports[],
+}
+
+export function bundle(
+ name: string,
+ language: string,
+ index: RuleExports[],
+): PluginExports {
+ return index.reduce((o: PluginExports, i: RuleExports) => {
+ o.rules[i.info.name] = i.rule;
+ return o;
+ }, {
+ name,
+ language,
+ rules: {},
+ index,
+ });
+}
diff --git a/lint/src/util/templates/index.ejs b/lint/src/util/templates/index.ejs
new file mode 100644
index 00000000000..d959f292910
--- /dev/null
+++ b/lint/src/util/templates/index.ejs
@@ -0,0 +1,5 @@
+[DSpace ESLint plugins](../../../lint/README.md) > <%= plugin.language %> rules
+_______
+<% rules.forEach(rule => { %>
+- [`<%= plugin.name %>/<%= rule.name %>`](./rules/<%= rule.name %>.md)<% if (rule.meta?.docs?.description) {%>: <%= rule.meta.docs.description.split('\n')[0].trim() -%><% }-%>
+<% }) %>
diff --git a/lint/src/util/templates/rule.ejs b/lint/src/util/templates/rule.ejs
new file mode 100644
index 00000000000..b39d193cc18
--- /dev/null
+++ b/lint/src/util/templates/rule.ejs
@@ -0,0 +1,48 @@
+[DSpace ESLint plugins](../../../../lint/README.md) > [<%= plugin.language %> rules](../index.md) > `<%= plugin.name %>/<%= rule.name %>`
+_______
+
+<%- rule.meta.docs?.description %>
+
+_______
+
+[Source code](../../../../lint/src/rules/<%- plugin.name.replace('dspace-angular-', '') %>/<%- rule.name %>.ts)
+
+### Examples
+
+<% if (tests.valid) {%>
+#### Valid code
+ <% tests.valid.forEach(test => { %>
+##### <%= test.name !== undefined ? test.name : 'UNNAMED' %>
+ <% if (test.filename) { %>
+Filename: `<%- test.filename %>`
+ <% } %>
+```<%- plugin.language.toLowerCase() %>
+<%- test.code.trim() %>
+```
+ <% }) %>
+<% } %>
+
+<% if (tests.invalid) {%>
+#### Invalid code <%= rule.meta.fixable ? ' & automatic fixes' : '' %>
+ <% tests.invalid.forEach(test => { %>
+##### <%= test.name !== undefined ? test.name : 'UNNAMED' %>
+ <% if (test.filename) { %>
+Filename: `<%- test.filename %>`
+ <% } %>
+```<%- plugin.language.toLowerCase() %>
+<%- test.code.trim() %>
+```
+Will produce the following error(s):
+```
+<% for (const error of test.errors) { -%>
+<%- rule.meta.messages[error.messageId] %>
+<% } -%>
+```
+ <% if (test.output) { %>
+Result of `yarn lint --fix`:
+```<%- plugin.language.toLowerCase() %>
+<%- test.output.trim() %>
+```
+ <% } %>
+ <% }) %>
+<% } %>
diff --git a/lint/src/util/theme-support.ts b/lint/src/util/theme-support.ts
new file mode 100644
index 00000000000..64644145fae
--- /dev/null
+++ b/lint/src/util/theme-support.ts
@@ -0,0 +1,265 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
+import { TSESTree } from '@typescript-eslint/utils';
+import { readFileSync } from 'fs';
+import { basename } from 'path';
+import ts, { Identifier } from 'typescript';
+
+import {
+ getComponentClassName,
+ isPartOfViewChild,
+} from './angular';
+import {
+ isPartOfClassDeclaration,
+ isPartOfTypeExpression,
+} from './typescript';
+
+/**
+ * Couples a themeable Component to its ThemedComponent wrapper
+ */
+export interface ThemeableComponentRegistryEntry {
+ basePath: string;
+ baseFileName: string,
+ baseClass: string;
+
+ wrapperPath: string;
+ wrapperFileName: string,
+ wrapperClass: string;
+}
+
+function isAngularComponentDecorator(node: ts.Node) {
+ if (node.kind === ts.SyntaxKind.Decorator && node.parent.kind === ts.SyntaxKind.ClassDeclaration) {
+ const decorator = node as ts.Decorator;
+
+ if (decorator.expression.kind === ts.SyntaxKind.CallExpression) {
+ const method = decorator.expression as ts.CallExpression;
+
+ if (method.expression.kind === ts.SyntaxKind.Identifier) {
+ return (method.expression as Identifier).text === 'Component';
+ }
+ }
+ }
+
+ return false;
+}
+
+function findImportDeclaration(source: ts.SourceFile, identifierName: string): ts.ImportDeclaration | undefined {
+ return ts.forEachChild(source, (topNode: ts.Node) => {
+ if (topNode.kind === ts.SyntaxKind.ImportDeclaration) {
+ const importDeclaration = topNode as ts.ImportDeclaration;
+
+ if (importDeclaration.importClause?.namedBindings?.kind === ts.SyntaxKind.NamedImports) {
+ const namedImports = importDeclaration.importClause?.namedBindings as ts.NamedImports;
+
+ for (const element of namedImports.elements) {
+ if (element.name.text === identifierName) {
+ return importDeclaration;
+ }
+ }
+ }
+ }
+
+ return undefined;
+ });
+}
+
+/**
+ * Listing of all themeable Components
+ */
+class ThemeableComponentRegistry {
+ public readonly entries: Set;
+ public readonly byBaseClass: Map;
+ public readonly byWrapperClass: Map;
+ public readonly byBasePath: Map;
+ public readonly byWrapperPath: Map;
+
+ constructor() {
+ this.entries = new Set();
+ this.byBaseClass = new Map();
+ this.byWrapperClass = new Map();
+ this.byBasePath = new Map();
+ this.byWrapperPath = new Map();
+ }
+
+ public initialize(prefix = '') {
+ if (this.entries.size > 0) {
+ return;
+ }
+
+ function registerWrapper(path: string) {
+ const source = getSource(path);
+
+ function traverse(node: ts.Node) {
+ if (node.parent !== undefined && isAngularComponentDecorator(node)) {
+ const classNode = node.parent as ts.ClassDeclaration;
+
+ if (classNode.name === undefined || classNode.heritageClauses === undefined) {
+ return;
+ }
+
+ const wrapperClass = classNode.name?.escapedText as string;
+
+ for (const heritageClause of classNode.heritageClauses) {
+ for (const type of heritageClause.types) {
+ if ((type as any).expression.escapedText === 'ThemedComponent') {
+ if (type.kind !== ts.SyntaxKind.ExpressionWithTypeArguments || type.typeArguments === undefined) {
+ continue;
+ }
+
+ const firstTypeArg = type.typeArguments[0] as ts.TypeReferenceNode;
+ const baseClass = (firstTypeArg.typeName as ts.Identifier)?.escapedText;
+
+ if (baseClass === undefined) {
+ continue;
+ }
+
+ const importDeclaration = findImportDeclaration(source, baseClass);
+
+ if (importDeclaration === undefined) {
+ continue;
+ }
+
+ const basePath = resolveLocalPath((importDeclaration.moduleSpecifier as ts.StringLiteral).text, path);
+
+ themeableComponents.add({
+ baseClass,
+ basePath: basePath.replace(new RegExp(`^${prefix}`), ''),
+ baseFileName: basename(basePath).replace(/\.ts$/, ''),
+ wrapperClass,
+ wrapperPath: path.replace(new RegExp(`^${prefix}`), ''),
+ wrapperFileName: basename(path).replace(/\.ts$/, ''),
+ });
+ }
+ }
+ }
+
+ return;
+ } else {
+ ts.forEachChild(node, traverse);
+ }
+ }
+
+ traverse(source);
+ }
+
+ const glob = require('glob');
+
+ // note: this outputs Unix-style paths on Windows
+ const wrappers: string[] = glob.GlobSync(prefix + 'src/app/**/themed-*.component.ts', { ignore: 'node_modules/**' }).found;
+
+ for (const wrapper of wrappers) {
+ registerWrapper(wrapper);
+ }
+ }
+
+ private add(entry: ThemeableComponentRegistryEntry) {
+ this.entries.add(entry);
+ this.byBaseClass.set(entry.baseClass, entry);
+ this.byWrapperClass.set(entry.wrapperClass, entry);
+ this.byBasePath.set(entry.basePath, entry);
+ this.byWrapperPath.set(entry.wrapperPath, entry);
+ }
+}
+
+export const themeableComponents = new ThemeableComponentRegistry();
+
+/**
+ * Construct the AST of a TypeScript source file
+ * @param file
+ */
+function getSource(file: string): ts.SourceFile {
+ return ts.createSourceFile(
+ file,
+ readFileSync(file).toString(),
+ ts.ScriptTarget.ES2020, // todo: actually use tsconfig.json?
+ /*setParentNodes */ true,
+ );
+}
+
+/**
+ * Resolve a possibly relative local path into an absolute path starting from the root directory of the project
+ */
+function resolveLocalPath(path: string, relativeTo: string) {
+ if (path.startsWith('src/')) {
+ return path;
+ } else if (path.startsWith('./')) {
+ const parts = relativeTo.split('/');
+ return [
+ ...parts.slice(0, parts.length - 1),
+ path.replace(/^.\//, ''),
+ ].join('/') + '.ts';
+ } else {
+ throw new Error(`Unsupported local path: ${path}`);
+ }
+}
+
+export function isThemedComponentWrapper(decoratorNode: TSESTree.Decorator): boolean {
+ if (decoratorNode.parent.type !== TSESTree.AST_NODE_TYPES.ClassDeclaration) {
+ return false;
+ }
+
+ if (decoratorNode.parent.superClass?.type !== TSESTree.AST_NODE_TYPES.Identifier) {
+ return false;
+ }
+
+ return (decoratorNode.parent.superClass as any)?.name === 'ThemedComponent';
+}
+
+export function getBaseComponentClassName(decoratorNode: TSESTree.Decorator): string | undefined {
+ const wrapperClass = getComponentClassName(decoratorNode);
+
+ if (wrapperClass === undefined) {
+ return;
+ }
+
+ themeableComponents.initialize();
+ const entry = themeableComponents.byWrapperClass.get(wrapperClass);
+
+ if (entry === undefined) {
+ return undefined;
+ }
+
+ return entry.baseClass;
+}
+
+export function isThemeableComponent(className: string): boolean {
+ themeableComponents.initialize();
+ return themeableComponents.byBaseClass.has(className);
+}
+
+export function inThemedComponentOverrideFile(filename: string): boolean {
+ const match = filename.match(/src\/themes\/[^\/]+\/(app\/.*)/);
+
+ if (!match) {
+ return false;
+ }
+ themeableComponents.initialize();
+ // todo: this is fragile!
+ return themeableComponents.byBasePath.has(`src/${match[1]}`);
+}
+
+export function allThemeableComponents(): ThemeableComponentRegistryEntry[] {
+ themeableComponents.initialize();
+ return [...themeableComponents.entries];
+}
+
+export function getThemeableComponentByBaseClass(baseClass: string): ThemeableComponentRegistryEntry | undefined {
+ themeableComponents.initialize();
+ return themeableComponents.byBaseClass.get(baseClass);
+}
+
+export function isAllowedUnthemedUsage(usageNode: TSESTree.Identifier) {
+ return isPartOfClassDeclaration(usageNode) || isPartOfTypeExpression(usageNode) || isPartOfViewChild(usageNode);
+}
+
+export const DISALLOWED_THEME_SELECTORS = 'ds-(base|themed)-';
+
+export function fixSelectors(text: string): string {
+ return text.replaceAll(/ds-(base|themed)-/g, 'ds-');
+}
diff --git a/lint/src/util/typescript.ts b/lint/src/util/typescript.ts
new file mode 100644
index 00000000000..0d04ef1a3d9
--- /dev/null
+++ b/lint/src/util/typescript.ts
@@ -0,0 +1,155 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { TSESTree } from '@typescript-eslint/utils';
+import {
+ RuleContext,
+ SourceCode,
+} from '@typescript-eslint/utils/ts-eslint';
+
+import {
+ match,
+ toUnixStylePath,
+} from './misc';
+
+export type AnyRuleContext = RuleContext;
+
+/**
+ * Return the current filename based on the ESLint rule context as a Unix-style path.
+ * This is easier for regex and comparisons to glob paths.
+ */
+export function getFilename(context: AnyRuleContext): string {
+ // TSESLint claims this is deprecated, but the suggested alternative is undefined (could be a version mismatch between ESLint and TSESlint?)
+ // eslint-disable-next-line deprecation/deprecation
+ return toUnixStylePath(context.getFilename());
+}
+
+export function getSourceCode(context: AnyRuleContext): SourceCode {
+ // TSESLint claims this is deprecated, but the suggested alternative is undefined (could be a version mismatch between ESLint and TSESlint?)
+ // eslint-disable-next-line deprecation/deprecation
+ return context.getSourceCode();
+}
+
+export function getObjectPropertyNodeByName(objectNode: TSESTree.ObjectExpression, propertyName: string): TSESTree.Node | undefined {
+ for (const propertyNode of objectNode.properties) {
+ if (
+ propertyNode.type === TSESTree.AST_NODE_TYPES.Property
+ && (
+ (
+ propertyNode.key?.type === TSESTree.AST_NODE_TYPES.Identifier
+ && propertyNode.key?.name === propertyName
+ ) || (
+ propertyNode.key?.type === TSESTree.AST_NODE_TYPES.Literal
+ && propertyNode.key?.value === propertyName
+ )
+ )
+ ) {
+ return propertyNode.value;
+ }
+ }
+ return undefined;
+}
+
+export function findUsages(context: AnyRuleContext, localNode: TSESTree.Identifier): TSESTree.Identifier[] {
+ const source = getSourceCode(context);
+
+ const usages: TSESTree.Identifier[] = [];
+
+ for (const token of source.ast.tokens) {
+ if (token.type === TSESTree.AST_TOKEN_TYPES.Identifier && token.value === localNode.name && !match(token.range, localNode.range)) {
+ const node = source.getNodeByRangeIndex(token.range[0]);
+ // todo: in some cases, the resulting node can actually be the whole program (!)
+ if (node !== null) {
+ usages.push(node as TSESTree.Identifier);
+ }
+ }
+ }
+
+ return usages;
+}
+
+export function findUsagesByName(context: AnyRuleContext, identifier: string): TSESTree.Identifier[] {
+ const source = getSourceCode(context);
+
+ const usages: TSESTree.Identifier[] = [];
+
+ for (const token of source.ast.tokens) {
+ if (token.type === TSESTree.AST_TOKEN_TYPES.Identifier && token.value === identifier) {
+ const node = source.getNodeByRangeIndex(token.range[0]);
+ // todo: in some cases, the resulting node can actually be the whole program (!)
+ if (node !== null) {
+ usages.push(node as TSESTree.Identifier);
+ }
+ }
+ }
+
+ return usages;
+}
+
+export function isPartOfTypeExpression(node: TSESTree.Identifier): boolean {
+ return node.parent?.type?.valueOf().startsWith('TSType');
+}
+
+export function isPartOfClassDeclaration(node: TSESTree.Identifier): boolean {
+ return node.parent?.type === TSESTree.AST_NODE_TYPES.ClassDeclaration;
+}
+
+function fromSrc(path: string): string {
+ const m = path.match(/^.*(src\/.+)(\.(ts|json|js)?)$/);
+
+ if (m) {
+ return m[1];
+ } else {
+ throw new Error(`Can't infer project-absolute TS/resource path from: ${path}`);
+ }
+}
+
+
+export function relativePath(thisFile: string, importFile: string): string {
+ const fromParts = fromSrc(thisFile).split('/');
+ const toParts = fromSrc(importFile).split('/');
+
+ let lastCommon = 0;
+ for (let i = 0; i < fromParts.length - 1; i++) {
+ if (fromParts[i] === toParts[i]) {
+ lastCommon++;
+ } else {
+ break;
+ }
+ }
+
+ const path = toParts.slice(lastCommon, toParts.length).join('/');
+ const backtrack = fromParts.length - lastCommon - 1;
+
+ let prefix: string;
+ if (backtrack > 0) {
+ prefix = '../'.repeat(backtrack);
+ } else {
+ prefix = './';
+ }
+
+ return prefix + path;
+}
+
+
+export function findImportSpecifier(context: AnyRuleContext, identifier: string): TSESTree.ImportSpecifier | undefined {
+ const source = getSourceCode(context);
+
+ const usages: TSESTree.Identifier[] = [];
+
+ for (const token of source.ast.tokens) {
+ if (token.type === TSESTree.AST_TOKEN_TYPES.Identifier && token.value === identifier) {
+ const node = source.getNodeByRangeIndex(token.range[0]);
+ // todo: in some cases, the resulting node can actually be the whole program (!)
+ if (node && node.parent && node.parent.type === TSESTree.AST_NODE_TYPES.ImportSpecifier) {
+ return node.parent;
+ }
+ }
+ }
+
+ return undefined;
+}
diff --git a/lint/test/fixture/README.md b/lint/test/fixture/README.md
new file mode 100644
index 00000000000..b19ae11b558
--- /dev/null
+++ b/lint/test/fixture/README.md
@@ -0,0 +1,9 @@
+# ESLint testing fixtures
+
+The files in this directory are used for the ESLint testing environment
+- Some rules rely on registries that must be built up _before_ the rule is run
+ - In order to test these registries, the fixture sources contain a few dummy components
+- The TypeScript ESLint test runner requires at least one dummy file to exist to run any tests
+ - By default, [`test.ts`](./src/test.ts) is used. Note that this file is empty; it's only there for the TypeScript configuration, the actual content is injected from the `code` property in the tests.
+ - To test rules that make assertions based on the path of the file, you'll need to include the `filename` property in the test configuration. Note that it must point to an existing file too!
+ - The `filename` must be provided as `fixture('src/something.ts')`
\ No newline at end of file
diff --git a/lint/test/fixture/index.ts b/lint/test/fixture/index.ts
new file mode 100644
index 00000000000..1d4f33f7e28
--- /dev/null
+++ b/lint/test/fixture/index.ts
@@ -0,0 +1,13 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
+export const FIXTURE = 'lint/test/fixture/';
+
+export function fixture(path: string): string {
+ return FIXTURE + path;
+}
diff --git a/lint/test/fixture/src/app/test/test-routing.module.ts b/lint/test/fixture/src/app/test/test-routing.module.ts
new file mode 100644
index 00000000000..1ccbccc5994
--- /dev/null
+++ b/lint/test/fixture/src/app/test/test-routing.module.ts
@@ -0,0 +1,14 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { ThemedTestThemeableComponent } from './themed-test-themeable.component';
+
+export const ROUTES = [
+ {
+ component: ThemedTestThemeableComponent,
+ },
+];
diff --git a/lint/test/fixture/src/app/test/test-themeable.component.ts b/lint/test/fixture/src/app/test/test-themeable.component.ts
new file mode 100644
index 00000000000..b445040539c
--- /dev/null
+++ b/lint/test/fixture/src/app/test/test-themeable.component.ts
@@ -0,0 +1,16 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { Component } from '@angular/core';
+
+@Component({
+ selector: 'ds-base-test-themeable',
+ template: '',
+ standalone: true,
+})
+export class TestThemeableComponent {
+}
diff --git a/lint/test/fixture/src/app/test/test.component.cy.ts b/lint/test/fixture/src/app/test/test.component.cy.ts
new file mode 100644
index 00000000000..2300ac4a56f
--- /dev/null
+++ b/lint/test/fixture/src/app/test/test.component.cy.ts
@@ -0,0 +1,8 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
diff --git a/lint/test/fixture/src/app/test/test.component.spec.ts b/lint/test/fixture/src/app/test/test.component.spec.ts
new file mode 100644
index 00000000000..2300ac4a56f
--- /dev/null
+++ b/lint/test/fixture/src/app/test/test.component.spec.ts
@@ -0,0 +1,8 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
diff --git a/lint/test/fixture/src/app/test/test.component.ts b/lint/test/fixture/src/app/test/test.component.ts
new file mode 100644
index 00000000000..c01f104c989
--- /dev/null
+++ b/lint/test/fixture/src/app/test/test.component.ts
@@ -0,0 +1,15 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { Component } from '@angular/core';
+
+@Component({
+ selector: 'ds-test',
+ template: '',
+})
+export class TestComponent {
+}
diff --git a/lint/test/fixture/src/app/test/test.module.ts b/lint/test/fixture/src/app/test/test.module.ts
new file mode 100644
index 00000000000..a37396ef459
--- /dev/null
+++ b/lint/test/fixture/src/app/test/test.module.ts
@@ -0,0 +1,24 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+// @ts-ignore
+import { NgModule } from '@angular/core';
+
+import { TestComponent } from './test.component';
+import { TestThemeableComponent } from './test-themeable.component';
+import { ThemedTestThemeableComponent } from './themed-test-themeable.component';
+
+@NgModule({
+ declarations: [
+ TestComponent,
+ TestThemeableComponent,
+ ThemedTestThemeableComponent,
+ ],
+})
+export class TestModule {
+
+}
diff --git a/lint/test/fixture/src/app/test/themed-test-themeable.component.ts b/lint/test/fixture/src/app/test/themed-test-themeable.component.ts
new file mode 100644
index 00000000000..2697a8c598e
--- /dev/null
+++ b/lint/test/fixture/src/app/test/themed-test-themeable.component.ts
@@ -0,0 +1,31 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { Component } from '@angular/core';
+
+import { ThemedComponent } from '../../../../../../src/app/shared/theme-support/themed.component';
+import { TestThemeableComponent } from './test-themeable.component';
+
+@Component({
+ selector: 'ds-test-themeable',
+ template: '',
+ standalone: true,
+ imports: [TestThemeableComponent],
+})
+export class ThemedTestThemeableComponent extends ThemedComponent {
+ protected getComponentName(): string {
+ return '';
+ }
+
+ protected importThemedComponent(themeName: string): Promise {
+ return Promise.resolve(undefined);
+ }
+
+ protected importUnthemedComponent(): Promise {
+ return Promise.resolve(undefined);
+ }
+}
diff --git a/src/app/browse-by/browse-by-metadata-page/browse-by-metadata-page.component.scss b/lint/test/fixture/src/test.ts
similarity index 100%
rename from src/app/browse-by/browse-by-metadata-page/browse-by-metadata-page.component.scss
rename to lint/test/fixture/src/test.ts
diff --git a/lint/test/fixture/src/themes/test/app/test/other-themeable.component.ts b/lint/test/fixture/src/themes/test/app/test/other-themeable.component.ts
new file mode 100644
index 00000000000..f72161b2bfc
--- /dev/null
+++ b/lint/test/fixture/src/themes/test/app/test/other-themeable.component.ts
@@ -0,0 +1,16 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { Component } from '@angular/core';
+
+@Component({
+ selector: 'ds-themed-test-themeable',
+ template: '',
+})
+export class OtherThemeableComponent {
+
+}
diff --git a/lint/test/fixture/src/themes/test/app/test/test-themeable.component.ts b/lint/test/fixture/src/themes/test/app/test/test-themeable.component.ts
new file mode 100644
index 00000000000..d2b02ca9f1f
--- /dev/null
+++ b/lint/test/fixture/src/themes/test/app/test/test-themeable.component.ts
@@ -0,0 +1,18 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { Component } from '@angular/core';
+
+import { TestThemeableComponent as BaseComponent } from '../../../../app/test/test-themeable.component';
+
+@Component({
+ selector: 'ds-themed-test-themeable',
+ template: '',
+})
+export class TestThemeableComponent extends BaseComponent {
+
+}
diff --git a/lint/test/fixture/src/themes/test/test.module.ts b/lint/test/fixture/src/themes/test/test.module.ts
new file mode 100644
index 00000000000..ff6ec3b2c0e
--- /dev/null
+++ b/lint/test/fixture/src/themes/test/test.module.ts
@@ -0,0 +1,22 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+// @ts-ignore
+import { NgModule } from '@angular/core';
+
+import { OtherThemeableComponent } from './app/test/other-themeable.component';
+import { TestThemeableComponent } from './app/test/test-themeable.component';
+
+@NgModule({
+ declarations: [
+ TestThemeableComponent,
+ OtherThemeableComponent,
+ ],
+})
+export class TestModule {
+
+}
diff --git a/lint/test/fixture/tsconfig.json b/lint/test/fixture/tsconfig.json
new file mode 100644
index 00000000000..0fd1141ae0e
--- /dev/null
+++ b/lint/test/fixture/tsconfig.json
@@ -0,0 +1,7 @@
+{
+ "extends": "../../tsconfig.json",
+ "include": [
+ "src/**/*.ts"
+ ],
+ "exclude": []
+}
diff --git a/lint/test/helpers.js b/lint/test/helpers.js
new file mode 100644
index 00000000000..bd648d007f5
--- /dev/null
+++ b/lint/test/helpers.js
@@ -0,0 +1,13 @@
+const SpecReporter = require('jasmine-spec-reporter').SpecReporter;
+const StacktraceOption = require('jasmine-spec-reporter').StacktraceOption;
+
+jasmine.getEnv().clearReporters(); // Clear default console reporter for those instead
+jasmine.getEnv().addReporter(new SpecReporter({
+ spec: {
+ displayErrorMessages: false,
+ },
+ summary: {
+ displayFailed: true,
+ displayStacktrace: StacktraceOption.PRETTY,
+ },
+}));
diff --git a/lint/test/rules.spec.ts b/lint/test/rules.spec.ts
new file mode 100644
index 00000000000..11c9bec46cf
--- /dev/null
+++ b/lint/test/rules.spec.ts
@@ -0,0 +1,26 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
+import { default as htmlPlugin } from '../src/rules/html';
+import { default as tsPlugin } from '../src/rules/ts';
+import {
+ htmlRuleTester,
+ tsRuleTester,
+} from './testing';
+
+describe('TypeScript rules', () => {
+ for (const { info, rule, tests } of tsPlugin.index) {
+ tsRuleTester.run(info.name, rule, tests as any);
+ }
+});
+
+describe('HTML rules', () => {
+ for (const { info, rule, tests } of htmlPlugin.index) {
+ htmlRuleTester.run(info.name, rule, tests);
+ }
+});
diff --git a/lint/test/structure.spec.ts b/lint/test/structure.spec.ts
new file mode 100644
index 00000000000..24e69e42d9a
--- /dev/null
+++ b/lint/test/structure.spec.ts
@@ -0,0 +1,76 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
+import { default as html } from '../src/rules/html';
+import { default as ts } from '../src/rules/ts';
+
+describe('plugin structure', () => {
+ for (const pluginExports of [ts, html]) {
+ const pluginName = pluginExports.name ?? 'UNNAMED PLUGIN';
+
+ describe(pluginName, () => {
+ it('should have a name', () => {
+ expect(pluginExports.name).toBeTruthy();
+ });
+
+ it('should have rules', () => {
+ expect(pluginExports.index).toBeTruthy();
+ expect(pluginExports.rules).toBeTruthy();
+ expect(pluginExports.index.length).toBeGreaterThan(0);
+ });
+
+ for (const ruleExports of pluginExports.index) {
+ const ruleName = ruleExports.info.name ?? 'UNNAMED RULE';
+
+ describe(ruleName, () => {
+ it('should have a name', () => {
+ expect(ruleExports.info.name).toBeTruthy();
+ });
+
+ it('should be included under the right name in the plugin', () => {
+ expect(pluginExports.rules[ruleExports.info.name]).toBe(ruleExports.rule);
+ });
+
+ it('should contain metadata', () => {
+ expect(ruleExports.info).toBeTruthy();
+ expect(ruleExports.info.name).toBeTruthy();
+ expect(ruleExports.info.meta).toBeTruthy();
+ expect(ruleExports.info.defaultOptions).toBeTruthy();
+ });
+
+ it('should contain messages', () => {
+ expect(ruleExports.Message).toBeTruthy();
+ expect(ruleExports.info.meta.messages).toBeTruthy();
+ });
+
+ describe('messages', () => {
+ for (const member of Object.keys(ruleExports.Message)) {
+ describe(member, () => {
+ const id = (ruleExports.Message as any)[member];
+
+ it('should have a valid ID', () => {
+ expect(id).toBeTruthy();
+ });
+
+ it('should have valid metadata', () => {
+ expect(ruleExports.info.meta.messages[id]).toBeTruthy();
+ });
+ });
+ }
+ });
+
+ it('should contain tests', () => {
+ expect(ruleExports.tests).toBeTruthy();
+ expect(ruleExports.tests.valid.length).toBeGreaterThan(0);
+ expect(ruleExports.tests.invalid.length).toBeGreaterThan(0);
+ });
+ });
+ }
+ });
+ }
+});
diff --git a/lint/test/testing.ts b/lint/test/testing.ts
new file mode 100644
index 00000000000..53faf320699
--- /dev/null
+++ b/lint/test/testing.ts
@@ -0,0 +1,53 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
+import { RuleTester as TypeScriptRuleTester } from '@typescript-eslint/rule-tester';
+import { RuleTester } from '@typescript-eslint/utils/ts-eslint';
+
+import { themeableComponents } from '../src/util/theme-support';
+import {
+ FIXTURE,
+ fixture,
+} from './fixture';
+
+
+// Register themed components from test fixture
+themeableComponents.initialize(FIXTURE);
+
+TypeScriptRuleTester.itOnly = fit;
+TypeScriptRuleTester.itSkip = xit;
+
+export const tsRuleTester = new TypeScriptRuleTester({
+ parser: '@typescript-eslint/parser',
+ defaultFilenames: {
+ ts: fixture('src/test.ts'),
+ tsx: 'n/a',
+ },
+ parserOptions: {
+ project: fixture('tsconfig.json'),
+ },
+});
+
+class HtmlRuleTester extends RuleTester {
+ run(name: string, rule: any, tests: { valid: any[], invalid: any[] }) {
+ super.run(name, rule, {
+ valid: tests.valid.map((test) => ({
+ filename: fixture('test.html'),
+ ...test,
+ })),
+ invalid: tests.invalid.map((test) => ({
+ filename: fixture('test.html'),
+ ...test,
+ })),
+ });
+ }
+}
+
+export const htmlRuleTester = new HtmlRuleTester({
+ parser: require.resolve('@angular-eslint/template-parser'),
+});
diff --git a/lint/test/theme-support.spec.ts b/lint/test/theme-support.spec.ts
new file mode 100644
index 00000000000..2edf9594b62
--- /dev/null
+++ b/lint/test/theme-support.spec.ts
@@ -0,0 +1,24 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
+import { themeableComponents } from '../src/util/theme-support';
+
+describe('theme-support', () => {
+ describe('themeable component registry', () => {
+ it('should contain all themeable components from the fixture', () => {
+ expect(themeableComponents.entries.size).toBe(1);
+ expect(themeableComponents.byBasePath.size).toBe(1);
+ expect(themeableComponents.byWrapperPath.size).toBe(1);
+ expect(themeableComponents.byBaseClass.size).toBe(1);
+
+ expect(themeableComponents.byBaseClass.get('TestThemeableComponent')).toBeTruthy();
+ expect(themeableComponents.byBasePath.get('src/app/test/test-themeable.component.ts')).toBeTruthy();
+ expect(themeableComponents.byWrapperPath.get('src/app/test/themed-test-themeable.component.ts')).toBeTruthy();
+ });
+ });
+});
diff --git a/lint/tsconfig.json b/lint/tsconfig.json
new file mode 100644
index 00000000000..d3537a73762
--- /dev/null
+++ b/lint/tsconfig.json
@@ -0,0 +1,27 @@
+{
+ "compilerOptions": {
+ "target": "ES2021",
+ "lib": [
+ "es2021"
+ ],
+ "module": "nodenext",
+ "moduleResolution": "nodenext",
+ "noImplicitReturns": true,
+ "skipLibCheck": true,
+ "strict": true,
+ "outDir": "./dist",
+ "sourceMap": true,
+ "allowSyntheticDefaultImports": true,
+ "types": [
+ "jasmine",
+ "node"
+ ]
+ },
+ "include": [
+ "**/*.ts",
+ ],
+ "exclude": [
+ "dist",
+ "test/fixture"
+ ]
+}
diff --git a/package.json b/package.json
index 69fff84bb40..a4f2ac9b37c 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "dspace-angular",
- "version": "7.6.1-next",
+ "version": "8.3.0",
"scripts": {
"ng": "ng",
"config:watch": "nodemon",
@@ -12,17 +12,21 @@
"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",
+ "build:lint": "rimraf 'lint/dist/**/*.js' 'lint/dist/**/*.js.map' && tsc -b lint/tsconfig.json",
"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",
+ "test:lint": "yarn build:lint && yarn test:lint:nobuild",
+ "test:lint:nobuild": "jasmine --config=lint/jasmine.json",
+ "lint": "yarn build:lint && yarn lint:nobuild",
+ "lint:nobuild": "ng lint",
+ "lint-fix": "yarn build:lint && ng lint --fix=true",
+ "docs:lint": "ts-node --project ./lint/tsconfig.json ./lint/generate-docs.ts",
+ "e2e": "cross-env NODE_ENV=production ng e2e",
"clean:dev:config": "rimraf src/assets/config.json",
"clean:coverage": "rimraf coverage",
"clean:dist": "rimraf dist",
@@ -40,7 +44,8 @@
"cypress:run": "cypress run",
"env:yaml": "ts-node --project ./tsconfig.ts-node.json scripts/env-to-yaml.ts",
"base-href": "ts-node --project ./tsconfig.ts-node.json scripts/base-href.ts",
- "check-circ-deps": "npx madge --exclude '(bitstream|bundle|collection|config-submission-form|eperson|item|version)\\.model\\.ts$' --circular --extensions ts ./"
+ "check-circ-deps": "npx madge --exclude '(bitstream|bundle|collection|config-submission-form|eperson|item|version)\\.model\\.ts$' --circular --extensions ts ./",
+ "postinstall": "yarn build:lint || echo 'Skipped DSpace ESLint plugins.'"
},
"browser": {
"fs": false,
@@ -49,132 +54,127 @@
"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": "^17.3.11",
+ "@angular/cdk": "^17.3.10",
+ "@angular/common": "^17.3.11",
+ "@angular/compiler": "^17.3.11",
+ "@angular/core": "^17.3.11",
+ "@angular/forms": "^17.3.11",
+ "@angular/localize": "17.3.12",
+ "@angular/platform-browser": "^17.3.11",
+ "@angular/platform-browser-dynamic": "^17.3.11",
+ "@angular/platform-server": "^17.3.11",
+ "@angular/router": "^17.3.11",
+ "@angular/ssr": "^17.3.17",
+ "@babel/runtime": "7.28.4",
"@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",
- "@ngrx/effects": "^15.4.0",
- "@ngrx/router-store": "^15.4.0",
- "@ngrx/store": "^15.4.0",
- "@nguniversal/express-engine": "^15.2.1",
+ "@ng-dynamic-forms/core": "^16.0.0",
+ "@ng-dynamic-forms/ui-ng-bootstrap": "^16.0.0",
+ "@ngrx/effects": "^17.1.1",
+ "@ngrx/router-store": "^17.1.1",
+ "@ngrx/store": "^17.1.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",
+ "axios": "^1.13.2",
"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",
+ "compression": "^1.8.1",
+ "cookie-parser": "1.4.7",
+ "core-js": "^3.47.0",
"date-fns": "^2.29.3",
"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",
+ "http-proxy-middleware": "^2.0.9",
"http-terminator": "^3.2.0",
- "isbot": "^3.6.10",
+ "isbot": "^5.1.32",
"js-cookie": "2.2.1",
- "js-yaml": "^4.1.0",
+ "js-yaml": "^4.1.1",
"json5": "^2.2.3",
- "jsonschema": "1.4.1",
+ "jsonschema": "1.5.0",
"jwt-decode": "^3.1.2",
"klaro": "^0.7.18",
"lodash": "^4.17.21",
"lru-cache": "^7.14.1",
"markdown-it": "^13.0.1",
- "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",
- "morgan": "^1.10.0",
- "ng-mocks": "^14.10.0",
- "ng2-file-upload": "1.4.0",
+ "mirador-share-plugin": "^0.16.0",
+ "morgan": "^1.10.1",
+ "ng2-file-upload": "5.0.0",
"ng2-nouislider": "^2.0.0",
- "ngx-infinite-scroll": "^15.0.0",
+ "ngx-infinite-scroll": "^16.0.0",
"ngx-pagination": "6.0.3",
- "ngx-sortablejs": "^11.1.0",
- "ngx-ui-switch": "^14.0.3",
+ "ngx-skeleton-loader": "^9.0.0",
+ "ngx-ui-switch": "^14.1.0",
"nouislider": "^15.7.1",
- "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",
+ "pem": "1.14.8",
+ "reflect-metadata": "^0.2.2",
+ "rxjs": "^7.8.2",
"uuid": "^8.3.2",
- "webfontloader": "1.6.28",
- "zone.js": "~0.11.5"
+ "zone.js": "~0.14.0"
},
"devDependencies": {
- "@angular-builders/custom-webpack": "~15.0.0",
- "@angular-devkit/build-angular": "^15.2.6",
- "@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-builders/custom-webpack": "~17.0.2",
+ "@angular-devkit/build-angular": "^17.3.17",
+ "@angular-eslint/builder": "17.5.3",
+ "@angular-eslint/bundled-angular-compiler": "17.5.3",
+ "@angular-eslint/eslint-plugin": "17.5.3",
+ "@angular-eslint/eslint-plugin-template": "17.5.3",
+ "@angular-eslint/schematics": "17.5.3",
+ "@angular-eslint/template-parser": "17.5.3",
+ "@angular/cli": "^17.3.17",
+ "@angular/compiler-cli": "^17.3.11",
+ "@angular/language-service": "^17.3.11",
"@cypress/schematic": "^1.5.0",
- "@fortawesome/fontawesome-free": "^6.4.0",
- "@ngrx/store-devtools": "^15.4.0",
- "@ngtools/webpack": "^15.2.6",
- "@nguniversal/builders": "^15.2.1",
- "@types/deep-freeze": "0.1.2",
+ "@fortawesome/fontawesome-free": "^6.7.2",
+ "@material-ui/core": "^4.12.4",
+ "@material-ui/icons": "^4.11.3",
+ "@ngrx/store-devtools": "^17.1.1",
+ "@ngtools/webpack": "^16.2.16",
+ "@types/deep-freeze": "0.1.5",
"@types/ejs": "^3.1.2",
"@types/express": "^4.17.17",
+ "@types/grecaptcha": "^3.0.9",
"@types/jasmine": "~3.6.0",
"@types/js-cookie": "2.2.6",
- "@types/lodash": "^4.14.194",
+ "@types/lodash": "^4.17.21",
"@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.2",
+ "@typescript-eslint/eslint-plugin": "^7.2.0",
+ "@typescript-eslint/parser": "^7.2.0",
+ "@typescript-eslint/rule-tester": "^7.2.0",
+ "@typescript-eslint/utils": "^7.2.0",
+ "axe-core": "^4.11.0",
"compression-webpack-plugin": "^9.2.0",
"copy-webpack-plugin": "^6.4.1",
"cross-env": "^7.0.3",
- "cypress": "12.17.4",
- "cypress-axe": "^1.4.0",
+ "csstype": "^3.2.3",
+ "cypress": "^13.17.0",
+ "cypress-axe": "^1.7.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-dspace-angular-html": "link:./lint/dist/src/rules/html",
+ "eslint-plugin-dspace-angular-ts": "link:./lint/dist/src/rules/ts",
+ "eslint-plugin-import": "^2.32.0",
+ "eslint-plugin-import-newlines": "^1.3.1",
+ "eslint-plugin-jsdoc": "^45.0.0",
+ "eslint-plugin-jsonc": "^2.21.0",
"eslint-plugin-lodash": "^7.4.0",
- "eslint-plugin-unused-imports": "^2.0.0",
- "express-static-gzip": "^2.1.7",
+ "eslint-plugin-rxjs": "^5.0.3",
+ "eslint-plugin-simple-import-sort": "^10.0.0",
+ "eslint-plugin-unused-imports": "^3.2.0",
+ "express-static-gzip": "^2.2.0",
+ "jasmine": "^3.8.0",
"jasmine-core": "^3.8.0",
"jasmine-marbles": "0.9.2",
"karma": "^6.4.2",
@@ -183,26 +183,25 @@
"karma-jasmine": "~4.0.0",
"karma-jasmine-html-reporter": "^1.5.0",
"karma-mocha-reporter": "2.2.5",
- "ngx-mask": "^13.1.7",
+ "ng-mocks": "^14.14.0",
+ "ngx-mask": "14.2.4",
"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.94.2",
"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"
+ "typescript": "~5.4.5",
+ "webpack": "5.101.0",
+ "webpack-cli": "^5.1.4",
+ "webpack-dev-server": "^5.2.2"
}
}
diff --git a/postcss.config.js b/postcss.config.js
index df092d1d39f..f8b9666b312 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/scripts/sync-i18n-files.ts b/scripts/sync-i18n-files.ts
index 96ba0d40105..6b3881b3b82 100644
--- a/scripts/sync-i18n-files.ts
+++ b/scripts/sync-i18n-files.ts
@@ -38,11 +38,13 @@ function parseCliInput() {
.usage('([-d ] [-s ]) || (-t (-i | -o