MultiPlatformValidator (Jervis 2.2 API)

net.gleske.jervis.lang.MultiPlatformValidator

All Implemented Interfaces and Traits:: Serializable

class MultiPlatformValidator
extends Object

Validates platforms, lifecycles, and toolchains for multiple operating systems; and their unstable counterparts; as a whole collection. This helps guarantee, for a given platforms file, lifecycles and toolchains are loaded for mult-platform matrix support.

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.beta.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')

Properties Summary

Properties
Type	Name and description
`List`	`known_operating_systems` All known operating systems across all platforms.
`List`	`known_platforms` All known platforms.
`List`	`known_toolchains` All known toolchains across all operating systems.
`Map<String, LifecycleValidator>`	`lifecycles` A mapping of known operating systems and their associated lifecycles of supported languages.
`PlatformValidator`	`platform_obj` An instance of the `PlatformValidator` class which as loaded a platforms file.
`Map<String, ToolchainValidator>`	`toolchains` A mapping of known operating systems and their associated toolchains of supported languages.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`LifecycleGenerator`	`getGeneratorFromJervis(Map options)` Creates a LifecycleGenerator object out of provided options.
	`List<String>`	`getLifecycleFiles()` Returns a list of file names without the extension in which to search for lifecycle files.
	`PipelineGenerator`	`getPipelineGeneratorForJervis(Map options)`
	`List<String>`	`getToolchainFiles()` Returns a list of file names without the extension in which to search for toolchain files.
	`void`	`loadLifecyclesString(String fileName, String yaml)` Load a lifecycles YAML `String` so that default scripts can be generated.
	`void`	`loadPlatformsString(String yaml)` Load a platforms YAML `String` so that advanced labels can be generated for multiple platforms.
	`void`	`loadToolchainsString(String fileName, String yaml)` Load a toolchains YAML `String` so that default scripts can be generated.
	`void`	`validate()` validate checks all supported operating systems and platforms to ensure that there's none missing.
	`void`	`validateJervisYaml(Map jervis_yaml)` If given a `.jervis.yml` file, validate it against the known platforms and operating systems.

Inherited Methods Summary

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

- Property Detail
  - List known_operating_systems
    
    All known operating systems across all platforms.
  - List known_platforms
    
    All known platforms.
  - List known_toolchains
    
    All known toolchains across all operating systems.
  - Map<String, LifecycleValidator> lifecycles
    
    A mapping of known operating systems and their associated lifecycles of supported languages.
  - PlatformValidator platform_obj
    
    An instance of the PlatformValidator class which as loaded a platforms file.
  - Map<String, ToolchainValidator> toolchains
    
    A mapping of known operating systems and their associated toolchains of supported languages.
- Method Detail
  - LifecycleGenerator getGeneratorFromJervis(Map options)
    
    Creates a LifecycleGenerator object out of provided options. Example with all options getGeneratorFromJervis(yaml: '', folder_listing: []
  - List<String> getLifecycleFiles()
    
    Returns a list of file names without the extension in which to search for lifecycle files.
    Returns:
    A list of stable and unstable lifecycle file names for each operating systing in the platforms.yaml file. This list is to be used for loading all known lifecycles including associated unstable lifecycles for each operating system.
  - PipelineGenerator getPipelineGeneratorForJervis(Map options)
  - List<String> getToolchainFiles()
    
    Returns a list of file names without the extension in which to search for toolchain files.
    Returns:
    A list of stable and unstable toolchain file names for each operating systing in the platforms.yaml file. This list is to be used for loading all known toolchains including associated unstable toolchains for each operating system.
  - void loadLifecyclesString(String fileName, String yaml)
    
    Load a lifecycles YAML String so that default scripts can be generated. Lifecycles provide the build portions of the script.
    Parameters:
    yaml - A String containing YAML which is from a lifecycles file.
  - void loadPlatformsString(String yaml)
    
    Load a platforms YAML String so that advanced labels can be generated for multiple platforms. A platform could be a local datacenter or a cloud providor. The platforms file allows labels to be generated which include stability, sudo access, and even operating system. This could be used to load lifecycles and toolchains by platform and OS.
    Parameters:
    yaml - A String containing YAML which is from a platforms file.
  - void loadToolchainsString(String fileName, String yaml)
    
    Load a toolchains YAML String so that default scripts can be generated. Toolchains provide the default tool setup of the script (e.g. what version of Java will be used).
    Parameters:
    fileName - The file name without the extension.
    yaml - A String containing YAML which is from a toolchains file.
  - void validate()
    
    validate checks all supported operating systems and platforms to ensure that there's none missing. It will also check for some invalid configurations.
  - void validateJervisYaml(Map jervis_yaml)
    
    If given a .jervis.yml file, validate it against the known platforms and operating systems. This will check the configuration against the loaded platforms, lifecycles, and toolchains for supported languages. It will throw errors for misconfiguration provided in the .jervis.yml file.
    Parameters:
    jervis_yaml - A POJO created from a parsed .jervis.yml file.

Summary:
Property
Method

| Detail:
Property
Method

Jervis API documentation.

[Groovy] Class MultiPlatformValidator

Sample usage

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

List known_operating_systems

List known_platforms

List known_toolchains

Map<String, LifecycleValidator> lifecycles

PlatformValidator platform_obj

Map<String, ToolchainValidator> toolchains

Method Detail

LifecycleGenerator getGeneratorFromJervis(Map options)

List<String> getLifecycleFiles()

PipelineGenerator getPipelineGeneratorForJervis(Map options)

List<String> getToolchainFiles()

void loadLifecyclesString(String fileName, String yaml)

void loadPlatformsString(String yaml)

void loadToolchainsString(String fileName, String yaml)

void validate()

void validateJervisYaml(Map jervis_yaml)