TemporaryJobs (Helios Testing Library 0.9.180 API)

java.lang.Object
- com.spotify.helios.testing.TemporaryJobs

All Implemented Interfaces:: org.junit.rules.TestRule

public class TemporaryJobs
extends Object
implements org.junit.rules.TestRule

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TemporaryJobs.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`TemporaryJobs.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`after()` Perform teardown.
`org.junit.runners.model.Statement`	`apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)`
`void`	`before()` Perform setup.
`static TemporaryJobs.Builder`	`builder()`
`static TemporaryJobs.Builder`	`builder(String profile)`
`HeliosClient`	`client()`
`static TemporaryJobs`	`create()` Creates a new instance of TemporaryJobs.
`static TemporaryJobs`	`create(HeliosClient client)`
`static TemporaryJobs`	`create(String domain)`
`static TemporaryJobs`	`createFromProfile(String profile)`
`TemporaryJobBuilder`	`job()`
`com.spotify.helios.testing.JobPrefixFile`	`jobPrefixFile()`
`TemporaryJobBuilder`	`jobWithConfig(String configFile)`
`String`	`prefix()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - before
```
public void before()
```
    Perform setup. This is normally called by JUnit when TemporaryJobs is used with @Rule. If @Rule cannot be used, call this method before calling job().
    Note: When not being used as a @Rule, jobs will not be monitored during test run.
  - after
```
public void after()
```
    Perform teardown. This is normally called by JUnit when TemporaryJobs is used with @Rule. If @Rule cannot be used, call this method after running tests.
  - job
```
public TemporaryJobBuilder job()
```
  - jobWithConfig
```
public TemporaryJobBuilder jobWithConfig(String configFile)
                                  throws IOException
```
    Throws:
    
    IOException
  - create
```
public static TemporaryJobs create()
```
    Creates a new instance of TemporaryJobs. Will attempt to connect to a helios master according to the following factors, where the order of precedence is top to bottom.
    1. HELIOS_DOMAIN - If set, use a helios master running in this domain.
    2. HELIOS_ENDPOINTS - If set, use one of the endpoints, which are specified as a comma separated list.
    3. Testing Profile - If a testing profile can be loaded, use either domain or endpoints if present. If both are specified, domain takes precedence.
    4. DOCKER_HOST - If set, assume a helios master is running on this host, so connect to it on port 5801.
    5. Use http://localhost:5801
    Returns:
    
    an instance of TemporaryJobs
    
    See Also:
    
    Helios Testing Framework - Configuration By File
  - create
```
public static TemporaryJobs create(HeliosClient client)
```
  - create
```
public static TemporaryJobs create(String domain)
```
  - createFromProfile
```
public static TemporaryJobs createFromProfile(String profile)
```
  - apply
```
public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runner.Description description)
```
    Specified by:
    
    apply in interface org.junit.rules.TestRule
  - jobPrefixFile
```
public com.spotify.helios.testing.JobPrefixFile jobPrefixFile()
```
  - prefix
```
public String prefix()
```
  - client
```
public HeliosClient client()
```
  - builder
```
public static TemporaryJobs.Builder builder()
```
  - builder
```
public static TemporaryJobs.Builder builder(String profile)
```

Class TemporaryJobs

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

before

after

job

jobWithConfig

create

create

create

createFromProfile

apply

jobPrefixFile

prefix

client

builder

builder