Che functional tests

Che functional tests verify capabilities of Che IDE. Earlier tests were more end-to-end focused (one big use case), now it is split into several test cases and it is concepted more like functional tests.

Prerequisites

• Running Che server on OpenShift. That means the Che server is running with configuration compatible with the runtime configuration of Che starter
• Che starter (optional) - It is not necessary to run Che starter - if you don't specify any URL where Che starter is available, then it will be automatically cloned from GH and started. Otherwise Che starter located at your URL will be used

Test execution

Due to some changes to che-starter, tests can run only against a remote OpenShift instance. OpenShift token of an instance has to be obtainable via REST call against a Keycloak (with keycloak token).

If you still want to run tests locally, you would have to create a new workspace manually and run tests against the workspace.

To run tests execute mvn clean verify with arguments listed below to run all tests.

Execution arguments

There are 2 ways how to run tests. Each of the following contains complete list of required and optional parameters. Run tests with fresh new workspace

• openShiftMasterURL - required; URL of OpenShift master where Che server is running
• keycloakToken - required; token to authenticate using Keycloak; token should be without the 'Bearer' prefix
• osioUsername - required; required if workspace use authentication in front of it (if you dont't have customized Che build)
• osioPassword - required; required if workspace use authentication in front of it (if you dont't have customized Che build)
• openShiftNamespace - required; project on OpenShift where Che is running; default is 'eclipse-che', but this is suitable only when running on minishift
• cheStarterURL - optional; URL of Che starter which is called to handle Che; if not provided, Che starter is started in set up step of these tests
• preserveWorkspace - optional, default false; set to true if you want to keep workspace after tests execution

Run tests against an existing workspace

• cheWorkspaceName - required, name of existing Che workspace
• osioUsername - required; required if workspace use authentication in front of it (if you dont't have customized Che build)
• osioPassword - required; required if workspace use authentication in front of it (if you dont't have customized Che build)

All before-mentioned properties are possible to set using arquillian.xml file. To do so, use an extension part with the qualifier che.:

<?xml version="1.0" encoding="UTF-8"?>
<arquillian xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://jboss.org/schema/arquillian"
    xsi:schemaLocation="http://jboss.org/schema/arquillian
    http://jboss.org/schema/arquillian/arquillian_1_0.xsd">

  <extension qualifier="che">
    <property name="openShiftToken">youropenshifttoken</property>
    <property name="openShiftMasterURL">https://your.openshift.master.url</property>
    <property name="openShiftNamespace">your-che-namespace</property>
    ...
  </extension>
  ...
</arquillian>

Known bugs and troubleshooting

• preserveWorkspace property does not work at the moment, it need some refactoring
• tests using commands UI are broken, because commands UI has changed in underlying Che server and it requires tests adjustment
• running tests on oldest Che server (pre 5.16 version) would not work because of changes in deployment template. It would work with slight modification of update tenant to use older template without modification of Che server tag