java-formula

Travis CI Build Status Semantic Release

Formula to install Java on GNU/Linux and MacOS, supporting multiple JDK/JRE providers (default is AdoptOpenJK):

1. General notes

See the full SaltStack Formulas installation and usage instructions.

If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.

If you want to use this formula, please pay attention to the FORMULA file and/or git tag, which contains the currently released version. This formula is versioned according to Semantic Versioning.

See Formula Versioning Section for more details.

If you need (non-default) configuration, please refer to:

2. Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

3. Special notes

Set java.provider = adopt|amazon|graalvm|haikuvm|intellij|oracle|zulu pillar to change jdk provider.

4. Available states

4.1. java

Meta-state (This is a state that includes other states).

This installs Java package, manages Java configuration file and then configures the development environment.

4.2. java.archive

This state will install Java from archive only.

4.3. java.macapp

This state will install Java macpackage on MacOS only, if supplied by provider.

4.4. java.package

This state installs default Java package supplied by OS if applicable (not recommended).

4.5. java.config

This state will configure java and/or environment and has a dependency on java.install via include list.

4.6. java.config.linuxenv

This state will setup Java linux-alternatives on GNU/Linux.

4.7. java.clean

Meta-state (This is a state that includes other states).

this state will undo everything performed in the java meta-state in reverse order, i.e. removes the configuration file and then uninstalls the package.

4.8. java.config.clean

This state will remove the configuration of Java and has a dependency on java.package.clean via include list.

4.9. java.archive.clean

This state will remove Java package and has a dependency on java.config.clean via include list.

4.10. java.macapp.clean

This state will remove Java mapackage and has a dependency on java.config.clean via include list.

4.11. java.config.linuxenv.clean

This state will remove Java linux-alternatives on GNU/Linux.

5. Testing

Linux testing is done with kitchen-salt.

5.1. Requirements

  • Ruby

  • Docker

$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]

Where [platform] is the platform name defined in kitchen.yml, e.g. debian-9-2019-2-py3.

5.2. bin/kitchen converge

Creates the docker instance and runs the java main state, ready for testing.

5.3. bin/kitchen verify

Runs the inspec tests on the actual instance.

5.4. bin/kitchen destroy

Removes the docker instance.

5.5. bin/kitchen test

Runs all of the stages above in one go: i.e. destroy + converge
verify + destroy.

5.6. bin/kitchen login

Gives you SSH access to the instance for manual testing.