Masters of Java

This project is a rebuild of the famous original Masters of Java software, originally built by Erik Hooijmeijer in 2004 see http://www.ctrl-alt-dev.nl/mastersofjava/. This project takes the original concept, but instead of a classical client/server Swing application, it is a complete web-based re-implementation.

Assignments for previous years can be found at https://github.com/First8/mastersofjava/.

Requirements

• Java 17+
• Maven 3.5+
• Keycloak
• PostgreSQL
• Docker (Optional)

Building

Building the software is done using maven. The command below will build the software and run all testcases.

$ mvn clean verify 

Building Containers

Building the containers is also done using maven and supports building to the docker-daemon and building and pushing to a registry directly.

Docker Build

To build all the containers in the Docker daemon the following can be used.

$ export REGISTRY=<your-registry>
$ mvn -Dmoj.image.base=${REGISTRY}/moj/moj -P docker-build clean deploy

Registry Build

To build and push all the containers to a container registry the following can be used.

$ export REGISTRY=<your-registry>
$ export REGISTRY_USERNAME=<your-push-user>
$ export REGISTRY_PASSWORD=<your-registry-password>

$ mvn -Dmoj.image.base=${REGISTRY}/moj/moj -P registry-build clean deploy

This will build and push all containers to your registry.

Running Containers

To run everything in containers see deploying with docker compose.

Running in Kubernetes

To run everything in Kubernetes see deploying with Helm.

Running Local

Running everything locally is primarily useful when developing. It will default use H2 as data storage, but PostgreSQL works too, but requires the datasource to be configured by adding the following to the application-*-local.yaml files for controller and single.

spring:
  datasource:
    url: jdbc:postgresql://<hostname>:<port>/<db>
    username: <username>
    password: <password>
    driver-class-name: org.postgresql.Driver

Preparation

Make sure you update the application.yaml to it works for the machine that is running the game server.

• The resources are default located in: ./moj-data/
• For downloading all javadocs via commandline: mvn dependency:sources dependency:resolve -Dclassifier=javadoc
• Download the newest SDK documentation and extract (directory api) into directory: ${moj.server.data-directory}/javadoc/api (now the participants can easily access to these docs via the GUI))
• This project requires a properly configured keycloak to run for user authentication, see below:

Keycloak installation, execution and configuration

Use the following steps to get Keycloak up and running.

• Download the latest standalone keycloak ( >= 21 ) from the link on the page here
• Unpack the installation file to a directory
• Copy the src/main/keycloak-template/moj directory from this project to themes directory within the keycloak installation directory. The themes folder should now have folder named moj.
• Run it using bin/kc.sh start --hostname localhost --hostname-strict-https false --http-enabled true --http-port 8888 (or for windows users: bin/kc.bat start --hostname localhost --hostname-strict-https false --http-enabled true --http-port 8888)
• Copy the src/deploy/docker-compose/iam/realms/realm-mastersofjava.json file and replace host.docker.internal with localhost.
• Go the webpage at http://localhost:8888
  • Create an admin account and log in
  • Open the top left dropdown and select 'Add realm'
    • Click on 'Browse' and select the realm-mastersofjava.json in the src/deploy/docker-compose/iam/realms folder.
    • Click 'Create'
  • Click on 'Users' in the menu bar on the left.
    • Click on 'Create new user' and fill in the following form values:
      • Email: 'your-email address'
      • Email verified: toggle to 'On'
      • Firstname: 'Jane'
      • Lastname: 'Doe'
      • Required user actions: leave blank
      • Click 'Join Groups'
        • Select admin
        • Click 'Join' and then 'Create'
      • Click on the 'Credentials' tab and then on 'Set password'
        • Fill in the two password fields with the same password
        • Toggle 'Temporary' to off
        • Click 'Save' and then 'Save password'

You should now have Keycloak running with a single admin user.

Starting

Masters of Java can run in three different modes:

• Single
• Controller
• Worker

Mode Single

The single mode runs both controller and worker in one. For running small competitions this will probably be good enough. To start in single mode you need to do the following:

• Copy the src/main/resources/application-single.yaml.tpl to src/main/resources/application-single-local.yaml
• Fill in the blanks
• Compile everything: mvn clean verify
• Start using mvn spring-boot:run -Dspring.profiles.active=single-local

Mode Controller

The controller mode starts only the controller part. You will need to attach a few workers, see Mode Worker for this. Use this when running bigger competitions ( > 5 teams). To start in controller mode you need to de to following:

• Copy the src/main/resources/application-controller.yaml.tpl to src/main/resources/application-controller-local.yaml
• Fill in the blanks
• Compile everything: mvn clean verify
• Start using mvn spring-boot:run -Dspring.profiles.active=controller-local

Mode Worker

The worker mode starts only the worker part. You will need to have a controller running to which you can connect. See Mode Controller for this. To start in worker mode you need to do the following:

• Copy the src/main/resources/application-worker.yaml.tpl to src/main/resources/application-worker-local.yaml
• Fill in the blanks
• Compile everything: mvn clean verify
• Start using mvn spring-boot:run -Dspring.profiles.active=worker-local

Depending on the amount of teams competing, you will need 1 or more workers. A good ratio is around 1 worker per 5 teams, though you might need more depending on the nature of the assignments. When assignments are heavy on testing or teams need to run tests or compiles all the time having more workers is better.

GUI

The Game Master dashboard can be found on http://localhost:8080/control. The first time you start the application you will have to log in using the admin credentials created in the keycloak setup and the MoJ game server admin console should appear.

All following web sessions will also be redirected to keycloak and one can create a new account there and log in. When you want to run the admin console and login with a user as well on the same desktop environment, you need to open a separate browser session, e.g. using a 'private window' or another browser implementation.

License

Copyright 2020-2024 First Eight BV (The Netherlands)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file / these files except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License 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.