Merge pull request #864 from europeana/develop

Merge develop into master

Author: andyjmaclean

.github/workflows/_deploy-sandbox.js.yaml

@@ -113,14 +113,14 @@ jobs:
           tags: |
             type=sha
             ${{ env.TAG_ESCAPED }}
-          #  type=schedule
-          #  type=ref,event=branch
-          #  type=ref,event=pr
-          #  type=semver,pattern={{version}}
-          #  type=semver,pattern={{major}}.{{minor}}
-          #  type=semver,pattern={{major}}
-          #  type=raw,value=latest,enable={{is_default_branch}}
-          #  ${{ env.PROJECT_VERSION }}
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=raw,value=latest,enable={{is_default_branch}}
+            ${{ env.PROJECT_VERSION }}
 
       - name: Build and push
         uses: docker/build-push-action@v5

.github/workflows/ci.yaml

@@ -0,0 +1,12 @@
+name: '* CI'
+on:
+  push
+jobs:
+  run-unit:
+    name: 'tests'
+    uses: ./.github/workflows/run-tests.yaml
+    secrets: inherit
+  run-sonar:
+    needs: [run-unit]
+    uses: ./.github/workflows/run-sonar.yaml
+    secrets: inherit

.github/workflows/deploy-image.yaml

@@ -16,6 +16,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.inputs.tag_name }}
       - name: Get Env File
         uses: actions/download-artifact@master
         with:

.github/workflows/run-sonar.yaml

@@ -2,13 +2,12 @@ name: '- helper (sonar)'
 on: workflow_call
 jobs:
   run-sonar:
-    if: ${{ github.event.inputs.run_build == 'true' }}
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
-          ref: ${{ github.event.inputs.tag_name }}
+          ref: ${{ github.event.inputs.tag_name || github.event.pull_request.head.ref }}
 
       - name: Get Metis LCOV
         uses: actions/download-artifact@master

.github/workflows/run-tests.yaml

@@ -7,7 +7,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
         with:
-          ref: ${{ github.event.inputs.tag_name }}
+          ref: ${{ github.event.inputs.tag_name || github.event.pull_request.head.ref }}
       - uses: actions/setup-node@v4
         with:
           node-version: '18.18.0'

package.json

@@ -55,7 +55,7 @@
     "tsc": "npm run tsc-test-data --project=metis && npm run tsc-test-data --project=sandbox",
     "cypress:ci-any": "run-p --race start:ci-any cypress:run --project=${npm_config_project}",
     "cypress:ci-accessibility-any": "run-p --race start:ci-any cypress:run-accessibility --project=${npm_config_project}",
-    "cypress:run": "sleep 10 && cypress run --project projects/${npm_config_project} --config '{\"component\": {},  \"e2e\": { \"excludeSpecPattern\": \"**/**a11y.cy.ts\"}}'",
+    "cypress:run": "sleep 10 && cypress run --project projects/${npm_config_project} --browser=chrome --config '{\"component\": {},  \"e2e\": { \"excludeSpecPattern\": \"**/**a11y.cy.ts\"}}'",
     "cypress:run-accessibility": "sleep 10 && cypress run --project projects/${npm_config_project} --spec **/*a11y.cy.ts",
     "cypress:open-sandbox": "cypress open --project projects/sandbox",
     "cypress": "cypress open --project projects/metis",

projects/metis/cypress/e2e/dataset.cy.ts

@@ -1,3 +1,4 @@
+import { DepublicationReasonHash } from '../../test-data/_data/depublication-reasons';
 import { checkAHref, cleanupUser, setupUser } from '../support/helpers';
 
 function setupDatasetPage(name: string, index: number): void {
@@ -27,6 +28,12 @@ context('metis-ui', () => {
       cy.get('.search-form').should('have.length', 1);
     });
 
+    it('should show the depublication reason', () => {
+      cy.get('.pill')
+        .contains(DepublicationReasonHash['REMOVED_DATA_AT_SOURCE'])
+        .should('exist');
+    });
+
     it('should show the throttle level', () => {
       cy.get('.last-execution')
         .contains(`Weak Throttle`)
@@ -100,8 +107,8 @@ context('metis-ui', () => {
     });
 
     it('should show the indexing_deleted_records status', () => {
-      getHistoryRow(2).contains('Transform');
-      getHistoryRow(2)
+      getHistoryRow(3).contains('Transform');
+      getHistoryRow(3)
         .get('.status-identifying_deleted_records')
         .should('have.length', 1);
     });

projects/metis/cypress/e2e/depublications.cy.ts

@@ -13,6 +13,7 @@ context('metis-ui', () => {
     const selMenuContentDepublish = '.dropdown-content.depublish';
     const selMenuOpenAdd = '.dropdown-options.add > a';
     const selMenuOpenDepublish = '.dropdown-options.depublish > a';
+    const selModalTitle = '.modal .head';
     const selItemDRecords = `${selMenuContentDepublish} :first-child a`;
     const selItemDDataset = `${selMenuContentDepublish} :last-child a`;
 
@@ -22,19 +23,30 @@ context('metis-ui', () => {
     const selItemInput = `${selMenuContentAdd} :last-child a`;
     const selLoadMore = '.tab-content .load-more-btn';
 
-    const submitEntries = (entries: string): void => {
+    const selSelectReason = '[name=depublicationReason]';
+    const testTexts = ['Test1', 'Test2'];
+
+    const submitEntriesOpen = (fileInput = false): void => {
       cy.get(selMenuOpenAdd).click(force);
-      cy.get(selItemInput)
+      const selInput = fileInput ? selItemFile : selItemInput;
+      cy.get(selInput)
         .scrollIntoView()
         .click(force);
+    };
+
+    const submitEntries = (entries: string, submit = true): void => {
+      submitEntriesOpen();
       cy.get('[name=recordIds]').type(entries);
-      cy.get('.modal [type="button"]').click();
+      if (submit) {
+        cy.get('.modal [type="submit"]').click();
+      }
       cy.wait(100);
     };
 
     const deleteVisibleEntries = (): void => {
+      const selDeleteBtn = `${selCtrls} .btn-delete`;
       cy.get(selCheckboxes).click({ force: true, multiple: true });
-      cy.get('.depublication-ctrls .btn-delete').click(force);
+      cy.get(selDeleteBtn).click(force);
       cy.wait(100);
     };
 
@@ -53,7 +65,18 @@ context('metis-ui', () => {
     describe('grid', () => {
       it('should show the grid and menus', () => {
         cy.get(selGrid).should('have.length', 1);
-        cy.get('.depublication-ctrls').should('have.length', 1);
+        cy.get(selCtrls).should('have.length', 1);
+      });
+
+      it('should show the grid headers', () => {
+        const selGridHeader = '.state-arrow';
+        ['Record Id', 'Record Status', 'Depublication Reason', 'Unpublished Date'].forEach(
+          (headerText: string) => {
+            cy.get(selGridHeader)
+              .contains(headerText)
+              .should('have.length', 1);
+          }
+        );
       });
     });
 
@@ -79,36 +102,42 @@ context('metis-ui', () => {
 
     describe('forms', () => {
       describe('successful operations', () => {
+        const modalTitle = 'Add record ids to depublish';
+
         it('should open and close the file dialog form', () => {
           cy.get(selDialogFile).should('not.exist');
-          cy.get(selMenuOpenAdd).click(force);
-          cy.get(selItemFile)
-            .scrollIntoView()
-            .click(force);
+          cy.get(selModalTitle).should('not.exist');
+          submitEntriesOpen(true);
 
+          cy.get(selModalTitle)
+            .contains(modalTitle)
+            .should('exist');
           cy.get(selDialogFile).should('be.visible');
           cy.get(selDialogClose).click();
           cy.get(selDialogFile).should('not.exist');
+          cy.get(selModalTitle).should('not.exist');
         });
 
         it('should open and close the input dialog form', () => {
           cy.get(selDialogInput).should('not.exist');
-          cy.get(selMenuOpenAdd).click(force);
-          cy.get(selItemInput)
-            .scrollIntoView()
-            .click(force);
+          cy.get(selModalTitle).should('not.exist');
+          submitEntriesOpen();
 
+          cy.get(selModalTitle)
+            .contains(modalTitle)
+            .should('exist');
           cy.get(selDialogInput).should('be.visible');
           cy.get(selDialogClose).click();
+
           cy.get(selDialogInput).should('not.exist');
+          cy.get(selModalTitle).should('not.exist');
         });
 
         it('should submit new entries', () => {
-          const testTexts = ['Test1', 'Test2'];
           submitEntries(testTexts.join('\n'));
 
           testTexts.forEach((txt) => {
-            cy.get('.record-url')
+            cy.get('[data-e2e=record-id]')
               .contains(txt)
               .should('have.length', 1);
           });
@@ -154,7 +183,7 @@ context('metis-ui', () => {
           cy.screenshot();
 
           testMore.slice(2).forEach((txt) => {
-            cy.get('.record-url')
+            cy.get('[data-e2e=record-id]')
               .contains(txt)
               .should('have.length', 1);
           });
@@ -184,29 +213,49 @@ context('metis-ui', () => {
     });
 
     describe('confirmations', () => {
+      const modalTitle = 'Depublish';
       const selDialogConfirm = '.modal-wrapper';
-      const selDialogConfirmClose = selDialogConfirm + ' .btn-close';
+      const selDialogConfirmClose = `${selDialogConfirm} .btn-close`;
 
       it('should ask confirmation for dataset depublication', () => {
         cy.get(selDialogConfirm).should('not.exist');
         cy.wait(1000);
         openDepublishMenu();
+        cy.get(selModalTitle).should('not.exist');
+        cy.get(selMenuContentDepublish).should('exist');
+
         cy.get(selItemDDataset).click(force);
+        cy.get(selModalTitle)
+          .contains(modalTitle)
+          .should('exist');
         cy.get(selDialogConfirm).should('be.visible');
+        cy.get(selSelectReason).should('exist');
+        cy.get(selSelectReason).should('be.visible');
+
         cy.get(selDialogConfirmClose).click();
         cy.get(selDialogConfirm).should('not.exist');
+        cy.get(selMenuContentDepublish).should('not.exist');
+        cy.get(selModalTitle).should('not.exist');
       });
 
       it('should ask confirmation for record id depublication', () => {
+        submitEntries(testTexts.join('\n'));
         submitEntries('Test1\nTest2');
         cy.get(selDialogConfirm).should('not.exist');
+        cy.get(selModalTitle).should('not.exist');
         cy.wait(1000);
         cy.get(selCheckbox).click({ force: true, multiple: true });
         openDepublishMenu();
+        cy.get(selMenuContentDepublish).should('exist');
         cy.get(selItemDRecords).click(force);
         cy.get(selDialogConfirm).should('be.visible');
+        cy.get(selModalTitle)
+          .contains(modalTitle)
+          .should('exist');
         cy.get(selDialogConfirmClose).click();
         cy.get(selDialogConfirm).should('not.exist');
+        cy.get(selMenuContentDepublish).should('not.exist');
+        cy.get(selModalTitle).should('not.exist');
         deleteVisibleEntries();
       });
     });

projects/metis/cypress/e2e/history.cy.ts

@@ -1,3 +1,4 @@
+import { DepublicationReasonHash } from '../../test-data/_data/depublication-reasons';
 import { cleanupUser, setupUser } from '../support/helpers';
 
 context('metis-ui', () => {
@@ -59,5 +60,12 @@ context('metis-ui', () => {
         .contains(`Strong Throttle`)
         .should('exist');
     });
+
+    it('should show the depublish reason', () => {
+      cy.visit('/dataset/log/3');
+      cy.get('.pill')
+        .contains(DepublicationReasonHash['GDPR'])
+        .should('exist');
+    });
   });
 });

projects/metis/src/app/_mocked/mockeddepublication.service.ts

@@ -2,7 +2,12 @@ import { HttpEvent } from '@angular/common/http';
 import { Observable, of as observableOf, throwError, timer } from 'rxjs';
 import { delay, switchMap } from 'rxjs/operators';
 
-import { DatasetDepublicationInfo, DepublicationStatus, RecordDepublicationInfo } from '../_models';
+import {
+  DatasetDepublicationInfo,
+  DepublicationReason,
+  DepublicationStatus,
+  RecordDepublicationInfo
+} from '../_models';
 
 export const mockPublicationInfo = [
   {
@@ -59,17 +64,23 @@ export class MockDepublicationService {
     return observableOf(true);
   }
 
-  depublishDataset(datasetId: string): Observable<boolean> {
+  depublishDataset(datasetId: string, depublicationReason: string): Observable<boolean> {
     if (this.errorMode) {
-      return throwError(new Error(`mock depublishDataset(${datasetId}) throws error...`));
+      return throwError(
+        new Error(`mock depublishDataset(${datasetId}/${depublicationReason}) throws error...`)
+      );
     }
     return observableOf(true);
   }
 
-  depublishRecordIds(datasetId: string, recordIds: Array<string>): Observable<boolean> {
+  depublishRecordIds(
+    datasetId: string,
+    reason: string,
+    recordIds: Array<string>
+  ): Observable<boolean> {
     if (this.errorMode) {
       return throwError(
-        new Error(`mock depublishRecordIds(${datasetId}, ${recordIds}) throws error...`)
+        new Error(`mock depublishRecordIds(${datasetId}, ${reason}, ${recordIds}) throws error...`)
       );
     }
     return observableOf(true);
@@ -96,6 +107,17 @@ export class MockDepublicationService {
     }
     return observableOf(true);
   }
+
+  getDepublicationReasons(): Observable<Array<DepublicationReason>> {
+    return observableOf(
+      ['GDPS', 'etc.'].map((s: string) => {
+        return {
+          name: s,
+          valueAsString: s
+        };
+      })
+    );
+  }
 }
 
 export class MockDepublicationServiceErrors extends MockDepublicationService {