Merge branch 'master' into 346-add-timeout-configuration

tdstein · web-flow · commit 0dcaa97aa0f9 · 2023-02-10T09:47:10.000-05:00
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -172,3 +172,45 @@ jobs:
       - name: Run tests
         run: |
           pytest -m 'vetiver'
+  
+  test-jupyter:
+    runs-on: ubuntu-latest
+    env: 
+      CONNECT_LICENSE: ${{ secrets.RSC_LICENSE }}
+      ADMIN_API_KEY: ${{ secrets.ADMIN_API_KEY }}
+    steps:
+      - uses: actions/checkout@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: extractions/setup-just@v1
+      - name: Build Containers
+        run: |
+            just integration-testing/build
+      - name: Start Connect + rsconnect-jupyter
+        run: |
+            just integration-testing/up
+        
+      - name: Run Cypress Tests
+        run: |
+            export ADMIN_API_KEY="${{ secrets.ADMIN_API_KEY }}"
+            just integration-testing/up-cypress
+
+      # Videos are captured whether the suite fails or passes
+      - name: Save videos
+        uses: actions/upload-artifact@v3
+        if: success() || failure()
+        with: 
+          name: cypress-videos
+          path: integration-testing/cypress/videos
+          if-no-files-found: ignore
+          retention-days: 1
+
+      # Screenshots are only captured on failure
+      - name: Save screenshots
+        uses: actions/upload-artifact@v3
+        if: failure()
+        with:
+          name: cypress-screenshots
+          path: integration-testing/cypress/screenshots
+          if-no-files-found: ignore
+          retention-days: 1
diff --git a/integration-testing/.gitignore b/integration-testing/.gitignore
@@ -0,0 +1,3 @@
+/client-python/
+/cypress/videos/
+/cypress/screenshots/
diff --git a/integration-testing/content/notebook/README.md b/integration-testing/content/notebook/README.md
@@ -0,0 +1,19 @@
+# Stock Report
+
+## About this example
+
+This stock report is generated using Python and Jupyter Notebook. Stock prices are populated from Quandl to generate a stock performance summary intended to run daily after market close.
+
+
+## Learn more
+
+* [Jupyter Homepage](https://jupyter.org/)
+* [Jupyter Documentation](https://jupyter.org/documentation)
+* [Using Jupyter Notebooks in {systemDisplayName}](https://docs.rstudio.com/connect/user/jupyter-notebook/)
+* [User Guide for rsconnect_jupyter](https://docs.rstudio.com/rsconnect-jupyter/)
+
+## Requirements
+
+* Python version 3.7 or higher
+
+<!-- NOTE: this file is generated -->
diff --git a/integration-testing/content/notebook/quandl-wiki-tsla.json.gz b/integration-testing/content/notebook/quandl-wiki-tsla.json.gz
diff --git a/integration-testing/content/notebook/requirements.txt b/integration-testing/content/notebook/requirements.txt
@@ -0,0 +1,3 @@
+jupyter==1.0.0
+matplotlib>=3.0.3<=3.5.1
+pandas>=0.25.3,<=1.4.1
diff --git a/integration-testing/content/notebook/stock-report-jupyter.ipynb b/integration-testing/content/notebook/stock-report-jupyter.ipynb
diff --git a/integration-testing/content/notebook/thumbnail.jpg b/integration-testing/content/notebook/thumbnail.jpg
diff --git a/integration-testing/cypress.config.js b/integration-testing/cypress.config.js
@@ -0,0 +1,21 @@
+// {
+//   "testFiles": "**/*.spec.js",
+//   "defaultCommandTimeout": 10000,
+//   "responseTimeout": 60000,
+//   "integrationFolder": "./cypress/integration/",
+//   "viewportHeight": 800
+// }
+
+const { defineConfig } = require('cypress')
+
+module.exports = defineConfig({
+  defaultCommandTimeout: 10000,
+  responseTimeout: 60000,
+  component: {
+    viewportHeight: 800
+  },
+  e2e: {
+    defaultCommandTimeout: 10000,
+    specPattern: "cypress/e2e/**/*.cy.js",
+  },
+})
diff --git a/integration-testing/cypress/e2e/jupyter.cy.js b/integration-testing/cypress/e2e/jupyter.cy.js
@@ -0,0 +1,52 @@
+describe('Publishing Jupyter Notebook', () => {
+
+  it('Publish button loads', () => {
+    cy.visit('http://client:9999/tree/integration-testing/content/notebook/stock-report-jupyter.ipynb');
+    cy.get('button[data-jupyter-action="rsconnect_jupyter:publish"]').click();
+    cy.get('a[id="publish-to-connect"]').should('be.visible')
+  });
+  // wait is required after every action, cypress is too fast for jupyter
+  // https://github.com/cypress-io/cypress/issues/249
+  it('Add Server', () => {
+    cy.visit('http://client:9999/tree/integration-testing/content/notebook/stock-report-jupyter.ipynb');
+    cy.wait(1000);
+    cy.get('a[id="publish-to-connect"]').click({ force: true });
+    cy.wait(1000);
+    cy.get('input[id="rsc-server"]').clear().type('http://connect:3939');
+    cy.get('input[id="rsc-api-key"]').clear().type(Cypress.env('api_key'));
+    cy.get('input[id="rsc-servername"]').clear().type('localhost');
+    cy.get('a[class="btn btn-primary"]').contains(' Add Server').click();
+    cy.wait(1000);
+    cy.get('span[class="help-block"]').should('not.have.text',"Unable to verify");
+  });
+  it('Publish Content', () => {
+    cy.visit('http://client:9999/tree/integration-testing/content/notebook/stock-report-jupyter.ipynb');
+    cy.wait(1000);
+    cy.get('a[id="publish-to-connect"]').click({ force: true });
+    cy.wait(1000);
+    cy.get('button[id="rsc-add-files"]').click();
+    cy.wait(1000);
+    cy.get('input[name="quandl-wiki-tsla.json.gz"]').click();
+    cy.wait(1000);
+    cy.get('button[id="add-files-dialog-accept"]').click();
+    cy.wait(1000);
+    cy.get('li[class="list-group-item"]').first().should('have.text'," quandl-wiki-tsla.json.gz");
+    cy.wait(1000);
+    cy.get('a[class="btn btn-primary"]').last().should('have.text',"Publish").click({ force: true });
+    cy.wait(1000);
+    cy.get('input[name="location"]').first().click();
+    cy.wait(1000);
+    cy.get('a[class="btn btn-primary"]').last().should('have.text',"Next").click();
+    cy.wait(1000);
+    cy.get('a[class="btn btn-primary"]').last().should('have.text',"Publish").click();
+    cy.wait(1000);
+    // allow for 5 minutes to deploy content
+    cy.get('span[class="fa fa-link"]', { timeout: 300000 }).last().should('have.text'," Successfully published content").click();
+  });
+  it('Vist Content in Connect', () => {
+    cy.connectLogin();
+    cy.visit('http://connect:3939');
+    cy.get('div[class="content-table__display-name"]').first().contains('stock-report-jupyter').click();
+    cy.contentiFrame().contains('Stock Report: TSLA');
+  });
+});
diff --git a/integration-testing/cypress/plugins/index.js b/integration-testing/cypress/plugins/index.js
@@ -0,0 +1,17 @@
+// ***********************************************************
+// This example plugins/index.js can be used to load plugins
+//
+// You can change the location of this file or turn off loading
+// the plugins file with the 'pluginsFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/plugins-guide
+// ***********************************************************
+
+// This function is called when a project is opened or re-opened (e.g. due to
+// the project's config changing)
+
+module.exports = (on, config) => {
+  // `on` is used to hook into various events Cypress emits
+  // `config` is the resolved Cypress config
+}
diff --git a/integration-testing/cypress/support/commands.js b/integration-testing/cypress/support/commands.js
@@ -0,0 +1,48 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+
+// https://www.cypress.io/blog/2020/02/12/working-with-iframes-in-cypress/
+Cypress.Commands.add('contentiFrame', (iframe) => {
+  // get the iframe > document > body
+  // and retry until the body element is not empty
+  cy.log('contentiFrame');
+
+  return cy
+    .get('iframe.appFrame', { log: false })
+    .its('0.contentDocument.body')
+    .should('not.be.empty')
+    // wraps "body" DOM element to allow
+    // chaining more Cypress commands, like ".find(...)"
+    // https://on.cypress.io/wrap
+    .then((body) => cy.wrap(body, { log: false }));
+});
+
+Cypress.Commands.add('connectLogin', (user) => {
+	cy.request('POST', 'http://connect:3939/__login__', {
+		username: 'admin',
+		password: 'password',
+	})
+});
diff --git a/integration-testing/cypress/support/e2e.js b/integration-testing/cypress/support/e2e.js
@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')
diff --git a/integration-testing/docker-compose.yml b/integration-testing/docker-compose.yml
@@ -0,0 +1,49 @@
+
+version: '3'
+
+services:
+  client:
+    image: client
+    hostname: client
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://client:9999/tree"]
+      interval: 40s
+      timeout: 3s
+      retries: 30
+    ports:
+      - 9999:9999
+    build: 
+      context: ./docker
+      dockerfile: client.Dockerfile
+    volumes:
+      - ../:/rsconnect-python 
+    working_dir: /rsconnect-python/integration-testing
+    entrypoint: ''
+
+  connect:
+    hostname: connect
+    image: rstudio/rstudio-connect:latest
+    restart: always
+    ports:
+      - 3939:3939
+    volumes:
+      - $PWD/docker/rstudio-connect.gcfg:/etc/rstudio-connect/rstudio-connect.gcfg
+    privileged: true
+    environment:
+      RSTUDIO_CONNECT_HASTE: "enabled"
+      RSC_LICENSE: ${CONNECT_LICENSE}
+
+  cypress:
+    image: cypress/included:12.0.0
+    depends_on:
+      client:
+        condition: service_healthy
+    build: 
+      context: ./docker
+      dockerfile: cypress.Dockerfile
+    volumes:
+      - ../:/rsconnect-python
+    working_dir: /rsconnect-python/integration-testing/
+    environment:
+      ADMIN_API_KEY: ${ADMIN_API_KEY}
+    entrypoint: ''
diff --git a/integration-testing/docker/client.Dockerfile b/integration-testing/docker/client.Dockerfile
@@ -0,0 +1,27 @@
+FROM python:3.9
+COPY ./requirements.txt .
+EXPOSE 9999
+VOLUME ../../:/rsconnect-python/
+
+WORKDIR /rsconnect-python/integration-testing
+
+RUN apt-get update && \
+      apt-get -y install sudo
+
+RUN mkdir -p /libs-client && \
+    curl -fsSL https://github.com/casey/just/releases/download/1.1.2/just-1.1.2-x86_64-unknown-linux-musl.tar.gz \
+    | tar -C /libs-client -xz just
+
+ENV PATH=$PATH:/libs-client
+
+RUN pip install rsconnect-jupyter && \
+    pip install pipenv && \
+    jupyter-nbextension install --sys-prefix --py rsconnect_jupyter
+
+CMD cd ../ && \
+    make deps dist && \
+    pip install ./dist/rsconnect_python-*.whl && \
+    jupyter-nbextension enable --sys-prefix --py rsconnect_jupyter && \
+    jupyter-serverextension enable --sys-prefix --py rsconnect_jupyter && \
+    jupyter-notebook \
+        -y --ip='0.0.0.0' --port=9999 --no-browser --NotebookApp.token='' --allow-root
diff --git a/integration-testing/docker/cypress.Dockerfile b/integration-testing/docker/cypress.Dockerfile
@@ -0,0 +1,12 @@
+FROM cypress/included:12.0.0
+
+RUN apt-get update -y && apt-get install -y --no-install-recommends \
+    jq
+
+RUN mkdir -p /libs-cypress && \
+    curl -fsSL https://github.com/casey/just/releases/download/1.1.2/just-1.1.2-x86_64-unknown-linux-musl.tar.gz \
+    | tar -C /libs-cypress -xz just
+
+ENV ADMIN_API_KEY=${ADMIN_API_KEY}
+ENV PATH=$PATH:/libs-cypress
+CMD cypress run --browser chrome --env api_key=${ADMIN_API_KEY}
diff --git a/integration-testing/docker/requirements.txt b/integration-testing/docker/requirements.txt
@@ -0,0 +1 @@
+rsconnect-jupyter
diff --git a/integration-testing/docker/rstudio-connect.gcfg b/integration-testing/docker/rstudio-connect.gcfg
@@ -0,0 +1,33 @@
+; Posit Connect test environment configuration
+
+[Server]
+SenderEmail = testuser@testrsc.com
+EmailProvider = print
+DataDir = /connect-rsconnect-data
+EnableSitemap = true
+AllowConfirmedUsers = true
+Address = http://localhost:3939
+JumpStartEnabled = false
+
+[HTTP]
+Listen = :3939
+NoWarning = true
+
+[Python]
+Enabled = true
+Executable = /opt/python/3.8.10/bin/python
+Executable = /opt/python/3.9.5/bin/python
+
+[Authentication]
+BasicAuth = true
+InsecureDefaultUserAPIKey = true
+APIKeyBcryptCost = 4
+
+[Authorization]
+DefaultUserRole = "publisher"
+
+[Database]
+SeedUsers = true
+
+[Mount]
+BaseDir = /connect-rsconnect-mount
diff --git a/integration-testing/justfile b/integration-testing/justfile

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+/client-python/`
	`2`	`+/cypress/videos/`
	`3`	`+/cypress/screenshots/`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+jupyter==1.0.0`
	`2`	`+matplotlib>=3.0.3<=3.5.1`
	`3`	`+pandas>=0.25.3,<=1.4.1`