Create selenium test user in Eclipse Che on OCP remotely by dmytro-ndp · Pull Request #9982 · eclipse-che/che

dmytro-ndp · 2018-06-08T16:11:37Z

What does this PR do?

It involves OpenShift CLI client into test user creation process when we are running E2E selenium tests against Eclipse Che Multiuser on OCP.
It makes it possible to create test user remotely when testing product is deployed to the remote host.

What issues does this PR fix or reference?

#9878

Signed-off-by: Dmytro Nochevnov <dnochevnov@codenvy.com>

dmytro-ndp · 2018-06-08T16:11:57Z

ci-test

codenvy-ci · 2018-06-08T16:52:58Z

ci-test build report:
Build details
Test report
selenium tests report data
docker image: eclipseche/che-server:9982
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.

Signed-off-by: Dmytro Nochevnov <dnochevnov@codenvy.com>

dmytro-ndp · 2018-06-08T17:21:11Z

ci-test

codenvy-ci · 2018-06-08T22:29:13Z

ci-test build report:
Build details
Test report
selenium tests report data
docker image: eclipseche/che-server:9982
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.

dmytro-ndp · 2018-06-09T06:11:16Z

ci-test

codenvy-ci · 2018-06-09T11:30:13Z

ci-test build report:
Build details
Test report
selenium tests report data
docker image: eclipseche/che-server:9982
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.

dmytro-ndp · 2018-06-10T04:46:42Z

ci-test

codenvy-ci · 2018-06-10T10:09:21Z

ci-test build report:
Build details
Test report
selenium tests report data
docker image: eclipseche/che-server:9982
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.

ghost · 2018-06-11T05:34:30Z

...java/org/eclipse/che/selenium/core/client/keycloak/executor/OpenShiftPodCommandExecutor.java

+
+  private static final boolean IS_MAC_OS =
+      System.getProperty("os.name").toLowerCase().startsWith("mac");
+  private static final String DEFAULT_OPENSHIFT_USERNAME = "developer";


So, this only works if auth isn't configured in the cluster (by default with oc cluster up)? Wouldn't it make more sense to have it in conf, so that you can run tests against Che deployed on any cluster?

I reserved environment variables for this propose: OPENSHIFT_USERNAME, OPENSHIFT_PASSWORD. It ought to be documented in some way.
https://github.com/eclipse/che/blob/31029ca5318894a911e9593d9b39c4fadf28b6ad/selenium/che-selenium-test/src/main/java/org/eclipse/che/selenium/core/client/keycloak/executor/OpenShiftPodCommandExecutor.java#L138-L139

ghost · 2018-06-11T05:35:25Z

...java/org/eclipse/che/selenium/core/client/keycloak/executor/OpenShiftPodCommandExecutor.java

+      Paths.get(System.getProperty("java.io.tmpdir"));
+
+  private static final Path PATH_TO_OPENSHIFT_CLI = PATH_TO_OPENSHIFT_CLI_DIRECTORY.resolve("oc");
+  public static final String ECLIPSE_CHE_NAMESPACE = "eclipse-che";


What if it's not eclipse-che namespace? Having it in configuration props will make it much more flexible.

Thank you for advice!

ghost · 2018-06-11T05:37:30Z

...java/org/eclipse/che/selenium/core/client/keycloak/executor/OpenShiftPodCommandExecutor.java

+  private static final boolean IS_MAC_OS =
+      System.getProperty("os.name").toLowerCase().startsWith("mac");
+  private static final String DEFAULT_OPENSHIFT_USERNAME = "developer";
+  private static final String DEFAULT_OPENSHIFT_PASSWORD = "any";


You may need a token since if cluster is configured with oAuth, there's no way you can do oc login -u -p. Can we introduce a token for such use cases? Say, before running a test, you obtain a token, export it as env (or save to configuration file) and then run tests.

Thank you for notice. Which environment variable we can use to hold the token?

You may pick any reasonable name. And if set, then oc login should use it. If not, username and password are used (default unless set by a user).

You can get your token this way:

oc login -u developer -p password oc whoami -t

My point is that even though this PR makes interaction with Keycloak more efficient, it won't help if you need to run tests against any infra that different from a default cluster started with oc cluster up

I can't find parameter to pass auth token to "oc login" command in docs.
Did you mean that we should add auth token directly into the ~/.kube/config file?

eugene@ivantsoft ~/projects/rhel-stacks/che-assembly (master) $ oc login --help Log in to your server and save login for subsequent use First-time users of the client should run this command to connect to a server, establish an authenticated session, and save connection to the configuration file. The default configuration will be saved to your home directory under ".kube/config". The information required to login -- like username and password, a session token, or the server details -- can be provided through flags. If not provided, the command will prompt for user input as needed. Usage: oc login [URL] [options] Examples: # Log in interactively oc login # Log in to the given server with the given certificate authority file oc login localhost:8443 --certificate-authority=/path/to/cert.crt # Log in to the given server with the given credentials (will not prompt interactively) oc login localhost:8443 --username=myuser --password=mypass Options: -p, --password='': Password, will prompt if not provided -u, --username='': Username, will prompt if not provided --certificate-authority='': Path to a cert file for the certificate authority --insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure --token='': Bearer token for authentication to the API server Use "oc options" for a list of global command-line options (applies to all commands). eugene@ivantsoft ~/projects/rhel-stacks/che-assembly (master) $

Thank you, Eugene.

ghost · 2018-06-11T05:41:06Z

...est/src/main/java/org/eclipse/che/selenium/core/provider/OpenShiftWebConsoleUrlProvider.java

+    if (!matcher.matches()) {
+      throw new RuntimeException(
+          format(
+              "It's impossible to extract OpenShift host from Eclipse Che host '%s'. Make sure that correct value is set for `CHE_INFRASTRUCTURE`.",


It's just a question. Can you explain why you need to extract Che host (route?) from OpenShift web console URL? Also, we should not forget that 8443 is the default port. It can be just 443 (OSO for example).

I am trying to avoid over-engineering here. It's kind of default behavior, but user is able to set OpenShift console URL manually through the "OPENSHIFT_URL" environment variable.

Ohrimenko1988 · 2018-06-11T09:39:34Z

.../src/main/java/org/eclipse/che/selenium/core/client/keycloak/KeycloakAdminConsoleClient.java

        format(
-            "docker exec -i %s sh -c 'keycloak/bin/kcadm.sh delete users/%s -r che -s username=%s --no-config --server http://localhost:8080/auth --user %s --password %s --realm master 2>&1'",
-            keycloakContainerId,
+            "delete users/%s -r che -s username=%s --no-config --server http://localhost:8080/auth --user %s --password %s --realm master 2>&1",


What about a case when "CHE_PORT" variable is different from default "8080"?

Here we are using different port - for keycloak server from within keycloak container.

Ohrimenko1988 · 2018-06-11T09:46:34Z

...a/org/eclipse/che/selenium/core/client/keycloak/executor/DockerContainerCommandExecutor.java

+
+/** @author Dmytro Nochevnov */
+@Singleton
+public class DockerContainerCommandExecutor implements KeycloakCommandExecutor {


In my opinion, the current name of the class "DockerContainerCommandExecutor" means that it describes the class which responsible for commands execution in some abstract docker container but not in the particular "Keycloak" container. Maybe it should be renamed to something like "DockerKeycloakCommandExecutor" or "KeycloakCommandExecutorImpl"?

You are particularly right, but I took into account the name of package: keycloak.executor.

Ohrimenko1988 · 2018-06-11T09:51:54Z

...est/src/main/java/org/eclipse/che/selenium/core/provider/OpenShiftWebConsoleUrlProvider.java

+@Singleton
+public class OpenShiftWebConsoleUrlProvider implements Provider<URL> {
+
+  private static final int PORT = 8443;


Is web console port always "8443" and can`t be reconfigured by any system variable?

It can be reconfigured manually through the "OPENSHIFT_URL" environment variable.

…CommandExecutor Signed-off-by: Dmytro Nochevnov <dnochevnov@codenvy.com>

Signed-off-by: Dmytro Nochevnov <dnochevnov@codenvy.com>

dmytro-ndp · 2018-06-11T16:21:29Z

ci-test

codenvy-ci · 2018-06-11T23:10:02Z

ci-test build report:
Build details
Test report
selenium tests report data
docker image: eclipseche/che-server:9982
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.

Signed-off-by: Dmytro Nochevnov <dnochevnov@codenvy.com>

…#9982) * Add KeycloakCommandExecutor to create test user in selenium tests * Create test user in Eclipse Che on OCP which is run remotely Signed-off-by: Dmytro Nochevnov <dnochevnov@codenvy.com>

Add KeycloakCommandExecutor to create test user in selenium tests

a09ee1e

Signed-off-by: Dmytro Nochevnov <dnochevnov@codenvy.com>

dmytro-ndp requested review from Ohrimenko1988 and musienko-maxim June 8, 2018 16:11

dmytro-ndp requested a review from vparfonov as a code owner June 8, 2018 16:11

dmytro-ndp added status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. kind/task Internal things, technical debt, and to-do tasks to be performed. labels Jun 8, 2018

Create test user in Eclipse Che on OCP which is run remotely

31029ca

Signed-off-by: Dmytro Nochevnov <dnochevnov@codenvy.com>

dmytro-ndp force-pushed the che-9878 branch from 7f2c6fc to 31029ca Compare June 8, 2018 17:20

ghost reviewed Jun 11, 2018

View reviewed changes

Ohrimenko1988 reviewed Jun 11, 2018

View reviewed changes

Fix names of classes DockerKeycloakCommandExecutor, OpenShiftKeycloak…

8cb09b7

…CommandExecutor Signed-off-by: Dmytro Nochevnov <dnochevnov@codenvy.com>

dmytro-ndp force-pushed the che-9878 branch from 4764ca0 to 8cb09b7 Compare June 11, 2018 10:37

Ohrimenko1988 approved these changes Jun 11, 2018

View reviewed changes

Dmytro Nochevnov added 2 commits June 11, 2018 19:19

Use openshift token instead of username/password credentials

19d7f0e

Signed-off-by: Dmytro Nochevnov <dnochevnov@codenvy.com>

Merge branch 'master' into che-9878

43a1a27

musienko-maxim approved these changes Jun 11, 2018

View reviewed changes

Fix README.md

2965a6c

Signed-off-by: Dmytro Nochevnov <dnochevnov@codenvy.com>

dmytro-ndp merged commit e75fbce into master Jun 12, 2018

dmytro-ndp deleted the che-9878 branch June 12, 2018 09:48

dmytro-ndp removed the status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. label Jun 12, 2018

dmytro-ndp added this to the 6.7.0 milestone Jun 12, 2018

Conversation

dmytro-ndp commented Jun 8, 2018

What does this PR do?

What issues does this PR fix or reference?

Uh oh!

dmytro-ndp commented Jun 8, 2018

Uh oh!

codenvy-ci commented Jun 8, 2018

Uh oh!

dmytro-ndp commented Jun 8, 2018

Uh oh!

codenvy-ci commented Jun 8, 2018

Uh oh!

dmytro-ndp commented Jun 9, 2018

Uh oh!

codenvy-ci commented Jun 9, 2018

Uh oh!

dmytro-ndp commented Jun 10, 2018

Uh oh!

codenvy-ci commented Jun 10, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dmytro-ndp Jun 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dmytro-ndp Jun 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dmytro-ndp commented Jun 11, 2018

Uh oh!

codenvy-ci commented Jun 11, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dmytro-ndp Jun 11, 2018 •

edited

Loading

dmytro-ndp Jun 11, 2018 •

edited

Loading