MultiPlatformGenerator (Jervis 2.2 API)

net.gleske.jervis.lang.MultiPlatformGenerator

All Implemented Interfaces and Traits:: Serializable

class MultiPlatformGenerator
extends Object

Creates a multi-platform generator similar to a LifecycleGenerator but multi-plaform and multi-os capable when building matrix combinations.

Sample usage

To run this example, clone Jervis and execute ./gradlew console to bring up a Groovy Console with the classpath set up.


import net.gleske.jervis.lang.MultiPlatformGenerator
import net.gleske.jervis.lang.MultiPlatformValidator

MultiPlatformValidator platforms = new MultiPlatformValidator()
platforms.loadPlatformsString(new File('resources/platforms.yaml').text)
platforms.getToolchainFiles().each { String fileName ->
    if(!new File("resources/${fileName}.yaml").exists()) { return }
    platforms.loadToolchainsString(fileName, new File("resources/${fileName}.yaml").text)
}
platforms.getLifecycleFiles().each { String fileName ->
    if(!new File("resources/${fileName}.yaml").exists()) { return }
    platforms.loadLifecyclesString(fileName, new File("resources/${fileName}.yaml").text)
}
platforms.getGeneratorFromJervis(yaml: 'language: shell')

MultiPlatformGenerator platformGenerator = new MultiPlatformGenerator(platforms)

platformGenerator.loadMultiPlatformYaml(yaml: '''
language: shell
jenkins:
  platform:
    - amd64
    - arm64
  os:
    - alpine3
    - ubuntu2204
''')

platformGenerator.generateToolchainSection()

Properties Summary

Properties
Type	Name and description
`String`	`defaultOS` If matrix building of operating systems is requested, the first in the List provided by the user will be known as the default operating system.
`String`	`defaultPlatform` If matrix building of platforms is requested, the first in the List provided by the user will be known as the default platform.
`List`	`operating_systems` A list of operating systems requested by user `.jervis.yml`.
`Map<String, Map<String, LifecycleGenerator>>`	`platform_generators` When user-provided `.jervis.yml` is split up into platforms and operating systems, the result will be a series of `LifecycleGenerator` objects; one for each platform/OS combination.
`Map<String, Map<String, Map>>`	`platform_jervis_yaml` When user-provided `.jervis.yml` is split up into platforms and operating systems, the result will a new `.jervis.yml` file unique to each platform/OS combination.
`List`	`platforms` A list of platforms requested by user `.jervis.yml`.
`MultiPlatformValidator`	`platforms_obj` Platforms, operating systems, lifecycles, and toolchains for all suported languages.
`Map`	`rawJervisYaml` A POJO parsed from the original user provided `.jervis.yml`.

Constructor Summary

Constructors
Constructor and description
`MultiPlatformGenerator (MultiPlatformValidator platforms)`
`MultiPlatformGenerator (LifecycleGenerator lifecycleGenerator)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`String`	`generateToolchainSection()`
	`List`	`getBuildableMatrixAxes()`
	`Map`	`getDefaultToolchainsEnvironment()`
	`LifecycleGenerator`	`getGenerator()` Get the `LifecycleGenerator` for a given default platform and OS.
	`Map`	`getJervisYaml()` Get the Jervis YAML for a given default platform and OS.
	`String`	`getJervisYamlString()`
	`List`	`getStashes()`
	`Boolean`	`isMatrixBuild()`
	`void`	`loadMultiPlatformYaml(Map options)`
	`List`	`validate(Map options)` Reviews the loaded Jervis YAML and detects invalid toolchains or languages.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, toString, hashCode, getClass, notify, notifyAll, wait, wait, wait`

- Property Detail
  - String defaultOS
    
    If matrix building of operating systems is requested, the first in the List provided by the user will be known as the default operating system.
  - String defaultPlatform
    
    If matrix building of platforms is requested, the first in the List provided by the user will be known as the default platform.
  - List operating_systems
    
    A list of operating systems requested by user .jervis.yml.
  - Map<String, Map<String, LifecycleGenerator>> platform_generators
    
    When user-provided .jervis.yml is split up into platforms and operating systems, the result will be a series of LifecycleGenerator objects; one for each platform/OS combination. The object is organized by platforms as a top-level key, with operating system as the child key; where the operating system contains the LifecycleGenerator object for that platform/OS combination.
    See Also:
    platform_jervis_yaml
  - Map<String, Map<String, Map>> platform_jervis_yaml
    
    When user-provided .jervis.yml is split up into platforms and operating systems, the result will a new .jervis.yml file unique to each platform/OS combination. This object contains the generated .jervis.yml objects associated with the LifecycleGenerator created for the platofmr/OS combination. The object is organized by platforms as a top-level key, with operating system as the child key; where the operating system contains the .jervis.yml object for that platform/OS combination.
    See Also:
    platform_generators
  - List platforms
    
    A list of platforms requested by user .jervis.yml.
  - final MultiPlatformValidator platforms_obj
    
    Platforms, operating systems, lifecycles, and toolchains for all suported languages. This includes all known support even if a .jervis.ymlM doesn't request it.
  - Map rawJervisYaml
    
    A POJO parsed from the original user provided .jervis.yml.
- Constructor Detail
  - MultiPlatformGenerator(MultiPlatformValidator platforms)
  - MultiPlatformGenerator(LifecycleGenerator lifecycleGenerator)
- Method Detail
  - String generateToolchainSection()
  - List getBuildableMatrixAxes()
  - Map getDefaultToolchainsEnvironment()
  - LifecycleGenerator getGenerator()
    
    Get the LifecycleGenerator for a given default platform and OS.
    See Also:
    defaultPlatform
    defaultOS
    Returns:
    A LifecycleGenerator instance.
  - Map getJervisYaml()
    
    Get the Jervis YAML for a given default platform and OS. If you're looking for the original multi-platform Jervis YAML, then refer to rawJervisYaml.
    See Also:
    defaultPlatform
    defaultOS
    Returns:
    A HashMap of the original parsed Jervis YAML.
  - String getJervisYamlString()
  - List getStashes()
  - Boolean isMatrixBuild()
  - void loadMultiPlatformYaml(Map options)
  - List validate(Map options)
    
    Reviews the loaded Jervis YAML and detects invalid toolchains or languages. This assumes a flattened YAML no matrix support. This would typically be used for validating default YAML loaded from elsewhere or multi-platform YAML which has been flattened by platform and OS.
    Parameters:
    options - A map of options requiring: platform, os, and yaml.
    Returns:
    A List of errors. If the list is empty, then there's no errors.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Jervis API documentation.

[Groovy] Class MultiPlatformGenerator

Sample usage

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

String defaultOS

String defaultPlatform

List operating_systems

Map<String, Map<String, LifecycleGenerator>> platform_generators

Map<String, Map<String, Map>> platform_jervis_yaml

List platforms

final MultiPlatformValidator platforms_obj

Map rawJervisYaml

Constructor Detail

MultiPlatformGenerator(MultiPlatformValidator platforms)

MultiPlatformGenerator(LifecycleGenerator lifecycleGenerator)

Method Detail

String generateToolchainSection()

List getBuildableMatrixAxes()

Map getDefaultToolchainsEnvironment()

LifecycleGenerator getGenerator()

Map getJervisYaml()

String getJervisYamlString()

List getStashes()

Boolean isMatrixBuild()

void loadMultiPlatformYaml(Map options)

List validate(Map options)