RoddyToolLib

Tool library used in BatchEuphoria and Roddy.

NOTE: This software is for research-use only (RUO).

Build

Building is as simple as

./gradlew build

If you are behind a firewall and need to access the internet via a proxy, you can configure the proxy in $HOME/.gradle/gradle.properties:

systemProp.http.proxyHost=HTTP_proxy
systemProp.http.proxyPort=HTTP_proxy_port
systemProp.https.proxyHost=HTTPS_proxy
systemProp.https.proxyPort=HTTPS_proxy_port

where you substitute the correct proxies and ports required for your environment.

Contributors Information

The full developer information is available in the Roddy documentation.

Some basic information:

• We use Semantic Versioning 2.0.
  • Release versions are named according to the pattern \d\.\d\.\d(-(RC)?\d+.
  • The first three levels are the "major", "minor", and "patch" number. The patch number is occasionally also called "build" number.
  • Additional to the major, minor, and patch numbers, a "revision" number -\d+ can be attached.
  • It is possible to tag release candidate using suffixes -RC\d+
• We use Github-Flow as branching models.
• Additional to the "master" branch for long-term support of older versions it is possible to have dedicated release branches.
  • Release branches should be named according to the pattern ReleaseBranch_\d+\.\d+(\.\d+).
• Issues can be marked with the following labels
  • in progress
  • bug::candidate
  • bug::minor
  • bug::normal
  • bug::critical

Change Log

Change log entries should have the form

* $version
   * major: A change that breaks backwards compatibility
   * minor: A change that adds features, without breaking backwards compatibility
   * patch: A change that does neither add a feature, nor breaks backwards compatibility

• 2.4.1

  • Patch: Library update
  • Patch: Changed one logging message
  • Patch: Fixed a unit test
  • Patch: Code layout refactorings and groovification

• 2.4.0

  • Minor: Improved reporting of stdout and stderr for executed commands
  • Minor: Renamed asExecutionResult to asSynchronousExecutionResult
  • Patch: Use Circle-CI instead of Travis-CI

• 2.3.0

  • Minor: Refactored AsyncExecutionResult and ExecutionResult to improve the stdout and stderr handling. This also affects ExecutionResult.resultLines field/accessors.
  • Minor: Improved support for additional output stream in LocalExecutionHelper
  • Changes are required for Roddy 3.6.1 improvements related to better error reporting and handling.

• 2.2.2

  • Patch: Moved from StringBuilder to StringBuffer in LocalExecutionHelper.

• 2.2.1

  • Minor: Made ExecutionResult.resultLines protected (from private)

• 2.2.0

  • Minor: Added AsyncExecutionResult
  • Minor: Cornercase bugfix RoddyConversionHelperMethods

• 2.1.1

  • Patch: Update to Gradle 5.1.1

• 2.1.0

  • Minor: Added DateTimeHelper
  • Minor: Added convertMapToTwoColumnsPrettyTable

• 2.0.0

  • Minor: Bash expression handling (escaping)
  • Minor: BufferValue is value type (implements hashCode and equals)
  • Patch: Code groovyfication

• 1.0.0

  • Major: Moved package from eilslabs to theroddywms
  • Minor: Added version management code
    • CompatibilityChecker
    • Improved version patterns
    • VersionInterval
  • Patch: Update Gradle version from 4.2.1 to 4.8

• 0.0.7

  • Added AsyncExecutionResult to handle asynchronous execution of command executions.