Merge pull request #10 from cisco-open/add_contribution_guidelines

Added Contributing guidelines and some minor renaming

Author: preet-dev

CONTRIBUTING.md

@@ -0,0 +1,19 @@
+## Contributing
+
+We love pull requests from everyone, especially if they are to expand the available functionality or address one of the [open issues](https://github.com/cisco-open/test-telemetry-generator/issues). You will need the following to start with:
+* Github access, obviously
+* JDK 11
+* Gradle 5.6.4 or above
+
+Once you have the above setup:
+* Clone the project
+* Create a new branch on your local machine
+* Make the changes and add tests for your changes
+* Run all tests in your local using
+`./gradlew clean build test` for Linux/Mac
+`gradlew.bat clean build test` for Windows
+Doing this in local will ensure that the tests pass on the Github workflow too
+* Push your branch and open a pull request with a good description of the changes being made
+* Someone will review and we may suggest some changes, improvements or alternatives
+
+Thank you and happy coding!

src/main/java/io/opentelemetry/contrib/generator/telemetry/cli/CLIProcessor.java

@@ -79,7 +79,7 @@ private static Options getOptions() {
                 .desc("Path to the trace definition YAML")
                 .hasArg()
                 .build();
-        Option cisTargetYAML = Option.builder("t")
+        Option targetEnvYAML = Option.builder("t")
                 .argName("target")
                 .desc("Path to the YAML containing details of the environment to target")
                 .hasArg()
@@ -90,15 +90,15 @@ private static Options getOptions() {
         options.addOption(metricDefinition);
         options.addOption(logsDefinition);
         options.addOption(traceDefinition);
-        options.addOption(cisTargetYAML);
+        options.addOption(targetEnvYAML);
 
         HelpFormatter formatter = new HelpFormatter();
         formatter.printHelp("test-telemetry-generator-all.jar", options, true);
         return options;
     }
 
-    private static PayloadHandler getPayloadHandler(String cisTargetYAML) {
-        TargetEnvironmentDetails targetEnvironmentDetails = getCISTargetDetails(cisTargetYAML);
+    private static PayloadHandler getPayloadHandler(String targetEnvYAML) {
+        TargetEnvironmentDetails targetEnvironmentDetails = getTargetEnvDetails(targetEnvYAML);
         if (StringUtils.defaultString(targetEnvironmentDetails.getUsername()).isBlank()) {
             throw new GeneratorException("Missing username in environment target YAML");
         }
@@ -126,17 +126,17 @@ private static PayloadHandler getPayloadHandler(String cisTargetYAML) {
                 new BasicAuthHandler(targetEnvironmentDetails.getUsername(), targetEnvironmentDetails.getPassword()));
     }
 
-    private static TargetEnvironmentDetails getCISTargetDetails(String cisTargetYAML) {
-        File yamlFile = new File(cisTargetYAML);
+    private static TargetEnvironmentDetails getTargetEnvDetails(String targetEnvYAML) {
+        File yamlFile = new File(targetEnvYAML);
         if (!(yamlFile.exists() && yamlFile.canRead())) {
-            throw new GeneratorException("Unable to read provided CIS target YAML file " + cisTargetYAML);
+            throw new GeneratorException("Unable to read provided target environment YAML file " + targetEnvYAML);
         }
 
         ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
         try {
             return mapper.readValue(yamlFile, TargetEnvironmentDetails.class);
         } catch (IOException e) {
-            throw new GeneratorException("Failed to parse CIS target details YAML " + cisTargetYAML + " due to " + e.getMessage());
+            throw new GeneratorException("Failed to parse target environment details YAML " + targetEnvYAML + " due to " + e.getMessage());
         }
     }
 

src/main/java/io/opentelemetry/contrib/generator/telemetry/logs/dto/LogDefinition.java

@@ -40,7 +40,7 @@ public class LogDefinition {
 
     public long validate(String requestID, Set<String> allEntityTypes, Integer globalPayloadFrequencySeconds) {
         if (StringUtils.defaultString(name).isBlank()) {
-            name = "log_by_vodka_" + ThreadLocalRandom.current().nextInt();
+            name = "log_by_ttg_" + ThreadLocalRandom.current().nextInt();
             log.warn("Name not found for log. Using " + name);
         }
         if (copyCount == null || copyCount < 1) {