Skip to content

Commit

Permalink
Adding some necessary details
Browse files Browse the repository at this point in the history
  • Loading branch information
augustocristian committed Jan 29, 2025
1 parent 6131799 commit 56e630e
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,11 +224,24 @@ Once created the different properties and configuration files, the single module

### Executing the Orchestration generator
Once all the files created and the `docker-compose.yml` is prepared, to execute the generator we only need to call the
main class `giis.retorch.orchestration.OrchestrationIntegrationTests.javaOrchestationGeneratorMainClass` with the following 3 parameters as arguments:
main class ` giis.retorch.orchestration.main.OrchestationGeneratorMainClass` into the test `/test` package with the following 3 parameters as arguments:
- `rootPackageNameTests`: String that specifies the root package name where tests are located.
- `systemName`: String that specifies the system name, must correspond with the name used in the [Resources JSON file](#create-the-resourcejson-file).
- `jenkinsFilePath`: String with the location where the `Jenkinsfile` will be created, it must be the project root.

The following snippet provides a simple call of the `OrchestrationGeneratorMainClass` for the project fullteaching:

```java
package com.fullteaching.e2e.no_elastest;

public class RetorchMain {
public static void main(String[] args) throws NoFinalActivitiesException, NoTGroupsInTheSchedulerException, EmptyInputException, IOException, URISyntaxException, NotValidSystemException, ClassNotFoundException {
String [] argum={"com.fullteaching.e2e.no_elastest.functional.test", "FullTeaching", "./"};
OrchestationGeneratorMainClass.main(argum);
}
}
```

### RETORCH Orchestration generator outputs
The generator provides four different outputs: the pipelining code, the necessary scripts to set up, tear down and execute the TJobs(`retorchfiles/scripts/tjoblifecycles`),
the infrastructure(`retorchfiles/scripts/coilifecycles`) and the different environment files of each TJob (`retorchfiles/envfiles`) :
Expand Down

0 comments on commit 56e630e

Please sign in to comment.