Node LTS is recommended

Notes

src/gitlab-oc is a symlink to packages/oc-pages. The oc-pages package is also used in the gitlab-oc repo, so take care when making changes and make sure the code stays portable between gitlab-oc and unfurl-gui. When importing modules from inside oc-pages/ to other locations inside the src/ directory, use the appropriate aliases to prevent resolver errors on gitlab-oc. Check vue.config.js to see what the current aliases resolve to.

See Apollo boilerplate added with vue add apollo... see https://apollo.vuejs.org/

Need to run yarn run apollo:start first to start the apollo graphql server (runs on port 4000).

see https://gitlab-org.gitlab.io/gitlab-ui/ and https://gitlab-org.gitlab.io/gitlab-svgs/

gitlab-ui wraps https://bootstrap-vue.org/ which wraps bootstrap 4

It also depends on https://portal-vue.linusb.org/ which we could use to build a vs-code like minimap of a view using http://asvd.github.io/syncscroll/ or similar.

Fixture/spec generation

Most integration tests hosted in this repository are based off of completed deployments or deployment drafts.

The easiest way to generate fixtures is to fill out a blueprint on unfurl.cloud and export the deployment via Unfurl cli.

1. Navigate to https://unfurl.cloud/home#clone-instructions or https://unfurl.cloud/<your-username>/dashboard#clone-instructions
2. Copy and execute the command line snippet for "Clone this Unfurl project if you haven't already"
3. Run unfurl export --format deployment --file <path-to-unfurl-gui>/cypress/fixtures/generated/deployments/v2/<export-name>.json <path-to-ensemble-yaml>

Jest patch/dryrun test

The test titled ufsv-patch mimics the workflow of a user filling out a deployment blueprint and triggering a dryrun deployment.

Required envvars and params

SPEC_GLOBS: Whitespace separated globs indicating which deployments to be run. Spec are found in cypress/fixtures/generated/deployments/v2 by default, but a different path will be searched depending on TEST_VERSIONS.

GOOGLE_APPLICATION_CREDENTIALS: Even dryrun tests fail when this variable is missing.

--runInBand: For now we do NOT want to try running tests in parallel.

Supported envvars

All Unfurl environment variables pass through to unfurl serve and unfurl deploy.

TEST_VERSIONS: Which version of specs to run (default: v2)

CI: If present, log commands to curl artifacts, write deploy logs to /tmp/${testName}-ufdryrun.log. Outputs will be optimized for this test's companion .gitlab-ci.yml workflow.

PORT: The port to run unfurl serve on (default: 5001)

OC_URL: Base url for jest. Also used for --cloud-server (default https://unfurl.cloud)

OC_NAMESPACE: Namespace to run tests against; in other words - where the blueprints are located. (default: onecommons/blueprints)

SAVE_DRYRUN_LOGS: Write dry run logs to disk.

Example invocation

env TF_PLUGIN_CACHE_DIR=/tmp/plugincache/ TF_DATA_DIR=/tmp/.terraform TF_PLUGIN_CACHE_MAY_BREAK_DEPENDENCY_LOCK_FILE=1 GOOGLE_APPLICATION_CREDENTIALS=/home/onecommons/oc-staging1-6aeb4c6ec6bc.json SPEC_GLOBS='*baserow*' yarn test ufsv-patch -- --runInBand

Default Unfurl envvars

const UNFURL_DEFAULT_ENV = {
  UNFURL_LOGGING: 'trace',
  UNFURL_HOME: '',
  UNFURL_SKIP_SAVE: 'never',
}

Test directory structure and outputs:

• /tmp/ufsv: The location of the test dashboard. Will be used as the working directory for unfurl serve and unfurl deploy.
• /tmp/repos: The location of --clone-root for unfurl serve.
• /tmp/ufartifacts: All deployments will be moved here between test runs, so as to not wipe debug information when the next spec is run. All ensemble.yaml files and artifacts will be present here after the suite has finished running.
• /tmp/${testName}-ufsv.log: Pattern for where unfurl serve logs will be written. Tip: use less -r to view.
• /tmp/${testName}-ufdryrun.log: Pattern for where unfurl deploy logs will be written when in CI (otherwise stdio). Tip: use less -r to view.

Triggering a test pipeline

A test can be triggered via curl | bash as below. The first parameter to the bash script is the test to run (equivalent to the $TEST variable mentioned under Cypress tests).

Example: curl https://raw.githubusercontent.com/onecommons/unfurl-gui/cy-tests/scripts/trigger-pipeline.sh | bash -s baserow will trigger the pipeline with $TEST set to baserow.

If successful the command will output the pipeline URL.

Cypress tests

Cypress tests can be automatically run through gitlab ci by setting the $TEST pipeline variable

Running an arbitrary test examples with $CY_COMMAND

• Run a single spec by setting $CY_COMMAND to : yarn run integration-test run --namespace onecommons/blueprints -- --browser chrome -s cypress/e2e/deployments/drafts.cy.js