@eeacms/volto-tableau 6.0.5 → 6.0.6

package/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+### [6.0.6](https://github.com/eea/volto-tableau/compare/6.0.5...6.0.6) - 17 November 2023
+
+#### :rocket: New Features
+
+- feat: clean up [Miu Razvan - [`73ff5c0`](https://github.com/eea/volto-tableau/commit/73ff5c0f61c947067006cecf3bd3ad003249d78c)]
+
+#### :hammer_and_wrench: Others
+
+- tests: add cypress for tableau [nileshgulia1 - [`6eca683`](https://github.com/eea/volto-tableau/commit/6eca6834b85cdab4ed82367fee32fdbbb35b0f5e)]
+- tests: update unit tests [nileshgulia1 - [`96cae09`](https://github.com/eea/volto-tableau/commit/96cae09eab2e737f032c97eb401a3efa88e68ec6)]
+- test: [JENKINS] Run cypress in started frontend container [valentinab25 - [`c7e81cb`](https://github.com/eea/volto-tableau/commit/c7e81cb0768f755dd4107a4998253d9bccc33809)]
+- comment test [Miu Razvan - [`a459525`](https://github.com/eea/volto-tableau/commit/a459525fdccf8ee61651d4cb2e04eb253e841c61)]
 ### [6.0.5](https://github.com/eea/volto-tableau/compare/6.0.4...6.0.5) - 15 November 2023
 
 #### :rocket: New Features

package/Jenkinsfile

@@ -159,7 +159,8 @@ pipeline {
                 script {
                   try {
                     sh '''docker run --pull always --rm -d --name="$IMAGE_NAME-plone" -e SITE="Plone" -e PROFILES="$BACKEND_PROFILES" -e ADDONS="$BACKEND_ADDONS" eeacms/plone-backend'''
-                    sh '''timeout -s 9 3600 docker run --shm-size=2g --cpu-quota=150000 --link $IMAGE_NAME-plone:plone --entrypoint=make --name="$IMAGE_NAME-cypress" --workdir=/app/src/addons/${GIT_NAME} -e "RAZZLE_INTERNAL_API_PATH=http://plone:8080/Plone" $IMAGE_NAME-frontend cypress-ci'''
+                    sh '''docker run -d --shm-size=3g --link $IMAGE_NAME-plone:plone --name="$IMAGE_NAME-cypress" -e "RAZZLE_INTERNAL_API_PATH=http://plone:8080/Plone" --entrypoint=make --workdir=/app/src/addons/$GIT_NAME $IMAGE_NAME-frontend start-ci'''
+                    sh '''timeout -s 9 1800 docker exec --workdir=/app/src/addons/${GIT_NAME} $IMAGE_NAME-cypress make cypress-ci'''
                   } finally {
                     try {
                       sh '''rm -rf cypress-videos cypress-results cypress-coverage cypress-screenshots'''
@@ -189,6 +190,10 @@ pipeline {
                       catchError(buildResult: 'SUCCESS', stageResult: 'SUCCESS') {
                         junit testResults: 'cypress-results/**/*.xml', allowEmptyResults: true
                       }
+                      catchError(buildResult: 'SUCCESS', stageResult: 'SUCCESS') {
+                        sh '''docker logs $IMAGE_NAME-cypress'''
+                      }
+                      sh script: "docker stop $IMAGE_NAME-cypress", returnStatus: true
                       sh script: "docker stop $IMAGE_NAME-plone", returnStatus: true
                       sh script: "docker rm -v $IMAGE_NAME-plone", returnStatus: true
                       sh script: "docker rm -v $IMAGE_NAME-cypress", returnStatus: true

package/Makefile

@@ -151,14 +151,12 @@ test-ci:
 
 .PHONY: start-ci
 start-ci:
+	cp .coverage.babel.config.js /app/babel.config.js
 	cd ../..
-	yarn start &
+	yarn start
 
 .PHONY: cypress-ci
 cypress-ci:
-	cp .coverage.babel.config.js /app/babel.config.js
-	make start-ci
 	$(NODE_MODULES)/.bin/wait-on -t 240000  http://localhost:3000
 	NODE_ENV=development make cypress-run
 
-

package/cypress/e2e/block-tableau.cy.js

@@ -0,0 +1,45 @@
+import { slateAfterEach } from '../support/e2e';
+
+describe('Blocks Tests', () => {
+  beforeEach((contentType = 'Document') => {
+    cy.intercept('GET', `/**/*?expand*`).as('content');
+    cy.intercept('GET', '/**/Document').as('schema');
+    cy.autologin();
+    cy.createContent({
+      contentType: 'Document',
+      contentId: 'cypress',
+      contentTitle: 'Cypress',
+    });
+    cy.createContent({
+      contentType: contentType,
+      contentId: 'my-page',
+      contentTitle: 'My Page',
+      path: 'cypress',
+    });
+    cy.visit('/cypress/my-page');
+    // cy.waitForResourceToLoad('@navigation');
+    // cy.waitForResourceToLoad('@breadcrumbs');
+    // cy.waitForResourceToLoad('@actions');
+    // cy.waitForResourceToLoad('@types');
+    cy.waitForResourceToLoad('my-page');
+    cy.navigate('/cypress/my-page/edit');
+  });
+  afterEach(slateAfterEach);
+
+  it('Add Tableau block', () => {
+    // when I add a maps block
+    cy.addNewBlock('tableau');
+
+    cy.get(`.sidebar-container .field-wrapper-url #field-url`).type(
+      'https://tableau-public.discomap.eea.europa.eu/views/GHGProjections/Dashboard1&:jsdebug=n',
+    );
+    cy.get('#toolbar-save').click();
+    cy.wait('@content');
+    cy.url().should('eq', Cypress.config().baseUrl + '/cypress/my-page');
+
+    // then the page view should contain the maps block
+    cy.get('#page-document iframe')
+      .should('have.attr', 'src')
+      .and('match', /\/\/tableau-public.discomap.eea.europa.eu\//);
+  });
+});

package/cypress/support/commands.js

@@ -71,8 +71,7 @@ Cypress.Commands.add(
           id: contentId,
           title: contentTitle,
           image: {
-            data:
-              'iVBORw0KGgoAAAANSUhEUgAAANcAAAA4CAMAAABZsZ3QAAAAM1BMVEX29fK42OU+oMvn7u9drtIPisHI4OhstdWZyt4fkcXX5+sAg74umMhNp86p0eJ7vNiKw9v/UV4wAAAAAXRSTlMAQObYZgAABBxJREFUeF7tmuty4yAMhZG4X2zn/Z92J5tsBJwWXG/i3XR6frW2Y/SBLIRAfaQUDNt8E5tLUt9BycfcKfq3R6Mlfyimtx4rzp+K3dtibXkor99zsEqLYZltblTecciogoh+TXfY1Ve4dn07rCDGG9dHSEEOg/GmXl0U1XDxTKxNK5De7BxsyyBr6gGm2/vPxKJ8F6f7BXKfRMp1xIWK9A+5ks25alSb353dWnDJN1k35EL5f8dVGifTf/4tjUuuFq7u4srmXC60yAmldLXIWbg65RKU87lcGxJCFqUPv0IacW0PmSivOZFLE908inPToMmii/roG+MRV/O8FU88i8tFsxV3a06MFUw0Qu7RmAtdV5/HVVaOVMTWNOWSwMljLhzhcB6XIS7OK5V6AvRDNN7t5VJWQs1J40UmalbK56usBG/CuCHSYuc+rkUGeMCViNRARPrzW52N3oQLe6WifNliSuuGaH3czbVNudI9s7ZLUCLHVwWlyES522o1t14uvmbblmVTKqFjaZYJFSTPP4dLL1kU1z7p0lzdbRulmEWLxoQX+z9ce7A8GqEEucllLxePuZwdJl1Lezu0hoswvTPt61DrFcRuujV/2cmlxaGBC7Aw6cpovGANwRiSdOAWJ5AGy4gLL64dl0QhUEAuEUNws+XxV+OKGPdw/hESGYF9XEGaFC7sNLMSXWJjHsnanYi87VK428N2uxpOjOFANcagLM5l+7mSycM8KknZpKLcGi6jmzWGr/vLurZ/0g4u9AZuAoeb5r1ceQhyiTPY1E4wUR6u/F3H2ojSpXMMriBPT9cezTto8Cx+MsglHL4fv1Rxrb1LVw9yvyQpJ3AhFnLZfuRLH2QsOG3FGGD20X/th/u5bFAt16Bt308KjF+MNOXgl/SquIEySX3GhaZvc67KZbDxcCDORz2N8yCWPaY5lyQZO7lQ29fnZbt3Xu6qoge4+DjXl/MocySPOp9rlvdyznahRyHEYd77v3LhugOXDv4J65QXfl803BDAdaWBEDhfVx7nKofjoVCgxnUAqw/UAUDPn788BDvQuG4TDtdtUPvzjSlXAB8DvaDOhhrmhwbywylXAm8CvaouikJTL93gs3y7Yy4VYbIxOHrcMizPqWOjqO9l3Uz52kibQy4xxOgqhJvD+w5rvokOcAlGvNCfeqCv1ste1stzLm0f71Iq3ZfTrPfuE5nhPtF+LvQE2lffQC7pYtQy3tdzdrKvd5TLVVzDetScS3nEKmmwDyt1Cev1kX3YfbvzNK4fzrlw+cB6vm+uiUgf2zdXI62241LawCb7Pi5FXFPF8KpzDoF/Sw2lg+GrHNbno1mhPu+VCF/vfMnw06PnUl6j48dVHD3jHNHPua+fc3o/5yp/zsGi0vYtzi3Pz5mHd4T6BWMIlewacd63AAAAAElFTkSuQmCC',
+            data: 'iVBORw0KGgoAAAANSUhEUgAAANcAAAA4CAMAAABZsZ3QAAAAM1BMVEX29fK42OU+oMvn7u9drtIPisHI4OhstdWZyt4fkcXX5+sAg74umMhNp86p0eJ7vNiKw9v/UV4wAAAAAXRSTlMAQObYZgAABBxJREFUeF7tmuty4yAMhZG4X2zn/Z92J5tsBJwWXG/i3XR6frW2Y/SBLIRAfaQUDNt8E5tLUt9BycfcKfq3R6Mlfyimtx4rzp+K3dtibXkor99zsEqLYZltblTecciogoh+TXfY1Ve4dn07rCDGG9dHSEEOg/GmXl0U1XDxTKxNK5De7BxsyyBr6gGm2/vPxKJ8F6f7BXKfRMp1xIWK9A+5ks25alSb353dWnDJN1k35EL5f8dVGifTf/4tjUuuFq7u4srmXC60yAmldLXIWbg65RKU87lcGxJCFqUPv0IacW0PmSivOZFLE908inPToMmii/roG+MRV/O8FU88i8tFsxV3a06MFUw0Qu7RmAtdV5/HVVaOVMTWNOWSwMljLhzhcB6XIS7OK5V6AvRDNN7t5VJWQs1J40UmalbK56usBG/CuCHSYuc+rkUGeMCViNRARPrzW52N3oQLe6WifNliSuuGaH3czbVNudI9s7ZLUCLHVwWlyES522o1t14uvmbblmVTKqFjaZYJFSTPP4dLL1kU1z7p0lzdbRulmEWLxoQX+z9ce7A8GqEEucllLxePuZwdJl1Lezu0hoswvTPt61DrFcRuujV/2cmlxaGBC7Aw6cpovGANwRiSdOAWJ5AGy4gLL64dl0QhUEAuEUNws+XxV+OKGPdw/hESGYF9XEGaFC7sNLMSXWJjHsnanYi87VK428N2uxpOjOFANcagLM5l+7mSycM8KknZpKLcGi6jmzWGr/vLurZ/0g4u9AZuAoeb5r1ceQhyiTPY1E4wUR6u/F3H2ojSpXMMriBPT9cezTto8Cx+MsglHL4fv1Rxrb1LVw9yvyQpJ3AhFnLZfuRLH2QsOG3FGGD20X/th/u5bFAt16Bt308KjF+MNOXgl/SquIEySX3GhaZvc67KZbDxcCDORz2N8yCWPaY5lyQZO7lQ29fnZbt3Xu6qoge4+DjXl/MocySPOp9rlvdyznahRyHEYd77v3LhugOXDv4J65QXfl803BDAdaWBEDhfVx7nKofjoVCgxnUAqw/UAUDPn788BDvQuG4TDtdtUPvzjSlXAB8DvaDOhhrmhwbywylXAm8CvaouikJTL93gs3y7Yy4VYbIxOHrcMizPqWOjqO9l3Uz52kibQy4xxOgqhJvD+w5rvokOcAlGvNCfeqCv1ste1stzLm0f71Iq3ZfTrPfuE5nhPtF+LvQE2lffQC7pYtQy3tdzdrKvd5TLVVzDetScS3nEKmmwDyt1Cev1kX3YfbvzNK4fzrlw+cB6vm+uiUgf2zdXI62241LawCb7Pi5FXFPF8KpzDoF/Sw2lg+GrHNbno1mhPu+VCF/vfMnw06PnUl6j48dVHD3jHNHPua+fc3o/5yp/zsGi0vYtzi3Pz5mHd4T6BWMIlewacd63AAAAAElFTkSuQmCC',
             encoding: 'base64',
             filename: 'image.png',
             'content-type': 'image/png',
@@ -535,3 +534,42 @@ Cypress.Commands.add(
     });
   },
 );
+
+Cypress.Commands.add('addNewBlock', (blockName, createNewSlate = false) => {
+  let block;
+  block = cy.getSlate(createNewSlate).type(`/${blockName}{enter}`);
+  return block;
+});
+
+Cypress.Commands.add('getSlate', (createNewSlate = false) => {
+  let slate;
+  if (createNewSlate) {
+    cy.get('.block.inner').last().type('{moveToEnd}{enter}');
+  }
+  cy.getIfExists(
+    SLATE_SELECTOR,
+    () => {
+      slate = cy.get(SLATE_SELECTOR).last();
+    },
+    () => {
+      slate = cy.get(SLATE_SELECTOR, { timeout: 10000 }).last();
+    },
+  );
+  return slate;
+});
+
+function getIfExists(
+  selector,
+  successAction = () => {},
+  failAction = () => {},
+) {
+  cy.get('body').then((body) => {
+    if (body.find(selector).length > 0 && successAction) {
+      successAction();
+    } else if (failAction) {
+      failAction();
+    }
+  });
+}
+
+Cypress.Commands.add('getIfExists', getIfExists);

package/cypress/support/e2e.js

@@ -35,10 +35,10 @@ export const slateBeforeEach = (contentType = 'Document') => {
     path: 'cypress',
   });
   cy.visit('/cypress/my-page');
-  cy.waitForResourceToLoad('@navigation');
-  cy.waitForResourceToLoad('@breadcrumbs');
-  cy.waitForResourceToLoad('@actions');
-  cy.waitForResourceToLoad('@types');
+  // cy.waitForResourceToLoad('@navigation');
+  // cy.waitForResourceToLoad('@breadcrumbs');
+  // cy.waitForResourceToLoad('@actions');
+  // cy.waitForResourceToLoad('@types');
   cy.waitForResourceToLoad('my-page');
   cy.navigate('/cypress/my-page/edit');
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-tableau",
-  "version": "6.0.5",
+  "version": "6.0.6",
   "description": "@eeacms/volto-tableau: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",

package/src/Blocks/EmbedTableauVisualization/View.jsx

@@ -1,6 +1,7 @@
 import React from 'react';
 import { connect } from 'react-redux';
 import { compose } from 'redux';
+import { Message } from 'semantic-ui-react';
 import { flattenToAppURL } from '@plone/volto/helpers';
 import { getContent } from '@plone/volto/actions';
 import { PrivacyProtection } from '@eeacms/volto-embed';
@@ -29,39 +30,43 @@ const View = (props) => {
     // eslint-disable-next-line
   }, [tableau_vis_url]);
 
+  if (props.mode === 'edit' && !tableau_vis_url) {
+    return (
+      <Message>
+        Please select a tableau visualization from block editor.
+      </Message>
+    );
+  }
+
+  if (props.mode === 'edit' && !tableau_visualization?.url) {
+    return <Message>Url is not set in the visualization</Message>;
+  }
+
+  if (!tableau_visualization?.url) {
+    return null;
+  }
+
   return (
     <div className="embed-tableau">
       <PrivacyProtection
         {...props}
         data={{ ...data, url: tableau_visualization?.url }}
       >
-        {!tableau_vis_url && (
-          <div>Please select a tableau visualization from block editor.</div>
-        )}
-        {!!tableau_vis_url && (
-          <>
-            {!tableau_visualization?.url && props.mode === 'edit' && (
-              <div>Url is not set in the visualization</div>
-            )}
-            {!!tableau_visualization?.url && (
-              <Tableau
-                data={{
-                  ...tableau_visualization,
-                  with_notes,
-                  with_sources,
-                  with_more_info,
-                  with_download,
-                  with_share,
-                  with_enlarge,
-                  tableau_height,
-                  tableau_vis_url,
-                }}
-                figure_note={figure_note}
-                sources={data_provenance.data || []}
-              />
-            )}
-          </>
-        )}
+        <Tableau
+          data={{
+            ...tableau_visualization,
+            with_notes,
+            with_sources,
+            with_more_info,
+            with_download,
+            with_share,
+            with_enlarge,
+            tableau_height,
+            tableau_vis_url,
+          }}
+          figure_note={figure_note}
+          sources={data_provenance.data || []}
+        />
       </PrivacyProtection>
     </div>
   );

package/src/Blocks/EmbedTableauVisualization/View.test.jsx

@@ -34,11 +34,12 @@ describe('View', () => {
   };
 
   it('should render the component', () => {
-    const { container } = render(
+    const { asFragment } = render(
       <Provider store={store}>
         <View data={data} />
       </Provider>,
     );
-    expect(container.querySelector('.embed-tableau')).toBeInTheDocument();
+    expect(asFragment()).toMatchSnapshot();
+    //expect(container.querySelector('.embed-tableau')).toBeInTheDocument();
   });
 });

package/src/Blocks/EmbedTableauVisualization/__snapshots__/View.test.jsx.snap

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`View should render the component 1`] = `<DocumentFragment />`;