jmelis / che-starter

REST endpoints for managing Eclipse Che servers and workspaces

che-starter

REST endpoints for managing Eclipse Che servers and workspaces.

Building from command line

Apache Maven is used for building the project:

    $ mvn clean verify

Running

There are several ways for running the project:

• Spring Boot Maven Plugin:

    $ mvn spring-boot:run

• From Eclipse IDE you can simply right-click on Application.java -> Run As.. -> Java Application

• From command line:

    $ java -jar target/che-starter-1.0-SNAPSHOT.jar

To tell it which application properties file to use (located in the src/main/resources directory) specify the spring.profiles.active parameter, like so:

    $ java -Dspring.profiles.active=local -jar target/che-starter-1.0-SNAPSHOT.jar 

Once the service is running, it would be available with Swagger documentation on http://localhost:10000/

• Docker container:

docker build -t rhche/che-starter .
docker run -p 10000:10000 -t rhche/che-starter

Profiles

There are two available profiles, local and test. To select which profile to use, add the -Dspring.profiles.active property to the command line:

    $ java -Dspring.profiles.active=local -jar target/che-starter-1.0-SNAPSHOT.jar

Debugging

There are several ways for debugging the project:

• From Eclipse IDE you can simply right-click on Application.java -> Debug As.. -> Java Application

• Running the project in the debug mode from the command line:

    $ java -Xdebug -Xrunjdwp:server=y,transport=dt_socket,address=8000,suspend=n -Dspring.profiles.active=local -jar target/che-starter-1.0-SNAPSHOT.jar 

Integration test

Integration tests are running as part of the build against multi-tenant Che server deployed on prod-preview osd. In order to successfully run those tests locally OSIO_USER_TOKEN env var must be set before building the project:

    $ export OSIO_USER_TOKEN=<OSIO_PROD_PREVIEW_USER_TOKEN>

Test can be skipped via -DskipTests mvn command line argument.

CI Jobs

1. https://ci.centos.org/job/devtools-che-starter-prcheck/

2. https://ci.centos.org/job/devtools-che-starter-build-che-credentials-master/

On success, the second job will push the che-starter image to Docker Hub. Another copy is pushed to the local CentOS CI registry. The CentOS CI Registry hosted image can then be used by other components in the CentOS CI services, either as triggers or as a point of integration.

Live preview

• http://che-starter-dsaas-preview.b6ff.rh-idev.openshiftapps.com

Testing with Minishift

che-starter can be tested locally against Minishift. The instructions for running Minishift can be found in the How to deploy che-starter on Minishift ? document.

Code Conventions

• Indent using spaces only
• New line in the end

Apache Maven Checkstyle Plugin is used for validating the code conventions. All conventions can be found in the checkstyle.xml

License

EPL 1.0, See LICENSE file.

License Maven Plugin is used for license management. In order to update headers in source files run the following command:

    $ mvn license:update-file-header