Initial test case using Cypress (#196)

* Initial test case using Cypress

* Add readme for how to run e2e tests

.cypress/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["plugin:cypress/recommended"]
+}

.cypress/fixtures/no_detector_index_response.json

@@ -0,0 +1,4 @@
+{
+  "ok": false,
+  "error": "[index_not_found_exception] no such index [.opendistro-anomaly-detectors], with { resource.type=\"index_or_alias\" & resource.id=\".opendistro-anomaly-detectors\" & index_uuid=\"_na_\" & index=\".opendistro-anomaly-detectors\" }"
+}

.cypress/integration/ad/dashboard/ad_dashboard.spec.ts

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/// <reference types="cypress" />
+
+import {
+  AD_PATH,
+  AD_URL,
+  API_URL_PREFIX,
+  APP_URL_PREFIX,
+  DASHBOARD,
+  DETECTORS,
+  SLASH,
+} from '../../../utils/constants';
+
+context('AD Dashboard', () => {
+  it('Empty dashboard - no detector', () => {
+    cy.server();
+    cy.route(
+      'GET',
+      [API_URL_PREFIX, AD_PATH, DETECTORS + '*'].join(SLASH),
+      'fixture:no_detector_index_response.json'
+    ).as('getDetectors');
+
+    cy.visit([APP_URL_PREFIX, AD_URL, DASHBOARD].join(SLASH));
+
+    cy.wait('@getDetectors', { requestTimeout: 60_000 });
+
+    cy.contains('h2', 'You have no detectors');
+  });
+});

.cypress/plugins/index.js

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/// <reference types="cypress" />
+// ***********************************************************
+// 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)
+
+/**
+ * @type {Cypress.PluginConfig}
+ */
+module.exports = (on, config) => {
+  // `on` is used to hook into various events Cypress emits
+  // `config` is the resolved Cypress config
+};

.cypress/support/index.js

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+// ***********************************************************
+// 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')

.cypress/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../tsconfig.json",
+  "include": ["**/*.*"]
+}

.cypress/utils/constants.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+export const AD_URL = 'opendistro-anomaly-detection-kibana#';
+export const APP_URL_PREFIX = 'app';
+export const API_URL_PREFIX = 'api';
+export const AD_PATH = 'anomaly_detectors';
+export const SLASH = '/';
+
+export const DASHBOARD = 'dashboard';
+export const DETECTORS = 'detectors';

.gitignore

@@ -14,3 +14,5 @@ coverage
 *.code-workspace
 offline-module-cache/v2/*
 offline-module-cache/v1/*
+.cypress/screenshots
+.cypress/videos

README.md

@@ -56,6 +56,10 @@ Example output: `./build/opendistro-anomaly-detection-kibana-1.8.0.0.zip`
 
   Runs the plugin tests.
 
+- `yarn test:e2e`
+
+  Start Kibana, wait for it to be available on `localhost:5601`, and runs end-to-end tests.
+
 ## Contributing to Open Distro for Elasticsearch Anomaly detection Kibana
 
 We welcome you to get involved in development, documentation, testing the anomaly detection plugin. See our [CONTRIBUTING.md](./CONTRIBUTING.md) and join in.

cypress.json

@@ -0,0 +1,10 @@
+{
+  "baseUrl": "http://localhost:5601",
+  "video": false,
+  "fixturesFolder": ".cypress/fixtures",
+  "integrationFolder": ".cypress/integration",
+  "pluginsFile": ".cypress/plugins/index.js",
+  "screenshotsFolder": ".cypress/screenshots",
+  "supportFile": ".cypress/support/index.js",
+  "videosFolder": ".cypress/videos"
+}

package.json

@@ -16,7 +16,11 @@
     "test:browser": "plugin-helpers test:browser",
     "test:jest": "../../node_modules/.bin/jest --config ./test/jest.config.js",
     "build": "plugin-helpers build",
-    "release": "./tasks/release.sh"
+    "release": "./tasks/release.sh",
+    "start-cy-server": "yarn start --no-base-path --oss",
+    "cy:open": "cypress open",
+    "cy:run": "cypress run",
+    "test:e2e": "WAIT_ON_TIMEOUT=900000 start-server-and-test 'yarn start-cy-server' http-get://localhost:5601/app/opendistro-anomaly-detection-kibana 'yarn cy:run'"
   },
   "lint-staged": {
     "*.{ts,tsx,js,jsx,json,css,md}": [
@@ -53,6 +57,7 @@
     "babel-jest": "^24.8.0",
     "babel-polyfill": "^6.26.0",
     "chance": "^1.1.0",
+    "cypress": "^4.6.0",
     "eslint": "^5.6.0",
     "eslint-plugin-babel": "^5.2.0",
     "eslint-plugin-import": "^2.14.0",
@@ -67,11 +72,13 @@
     "moment-timezone": "^0.5.26",
     "react-router-dom": "^5.0.1",
     "redux-mock-store": "^1.5.3",
+    "start-server-and-test": "^1.11.0",
     "typescript": "3.0.3"
   },
   "dependencies": {
     "@elastic/charts": "^18.2.2",
     "babel-polyfill": "^6.26.0",
+    "eslint-plugin-cypress": "^2.11.1",
     "formik": "^1.5.8",
     "query-string": "^6.8.2",
     "react-redux": "^7.1.0",

tsconfig.json

@@ -5,12 +5,8 @@
     "paths": {
       // Allows for importing from `kibana` package for the exported types.
       "kibana": ["./kibana"],
-      "ui/*": [
-        "src/legacy/ui/public/*"
-      ],
-      "test_utils/*": [
-        "src/test_utils/public/*"
-      ]
+      "ui/*": ["src/legacy/ui/public/*"],
+      "test_utils/*": ["src/test_utils/public/*"]
     },
     // Support .tsx files and transform JSX into calls to React.createElement
     "jsx": "react",
@@ -49,12 +45,14 @@
     // import tslib helpers rather than inlining helpers for iteration or spreading, for instance
     "importHelpers": true,
     // adding global typings
-    "types": [
-      "node",
-      "jest",
-      "react"
-    ]
+    "types": ["node", "jest", "react"]
   },
-  "include": ["server/**/*", "public/**/*", "utils/**/*", "models/**/*", "test/**/*"],
-  "exclude": ["node_modules", "*/node_modules/"],
+  "include": [
+    "server/**/*",
+    "public/**/*",
+    "utils/**/*",
+    "models/**/*",
+    "test/**/*"
+  ],
+  "exclude": ["node_modules", "*/node_modules/"]
 }