Add a gradle task to generate the UML images (#258)

* Add a gradle task to generate the UML images
And generate existing UMLs

* Update buildSrc/src/main/java/com/microsoft/hydralab/compile/UMLImageGenerator.java

* Update agent/doc/UML/test_runner_design.puml

* Comments resolved

Author: hydraxman

agent/doc/UML/agent_device_management_design.puml

@@ -1,4 +1,4 @@
-@startuml new_design
+@startuml
 'https://plantuml.com/class-diagram
 
 class AgentManagementService {

agent/doc/UML/logger_file_design.puml

@@ -1,4 +1,4 @@
-@startuml
+@startuml log_file_path
 'https://plantuml.com/class-diagram
 
 object DeviceLogger
@@ -16,6 +16,6 @@ TestRunLogger -u-|> DeviceLogger
 
 @startuml loggers
 EachTestDevice *--> DeviceLogger
-EachTestTaskOnEachTargetDevice *--> TaskOnDeviceLogger
-EachTestTaskOnEachTargetDevice *--> LogcatLogger
+EachTestRun *--> TestRunLogger
+AndroidDevice *--> LogcatLogger
 @enduml

agent/doc/UML/test_runner_design.puml

@@ -1,4 +1,4 @@
-@startuml test_runners_classes
+@startuml test_runner_class_relation
 abstract class TestRunner {
     #createTestRun(...)
     #setUp(TestTask)
@@ -114,7 +114,7 @@ deactivate TaskCompletion
 }
 @endjson
 
-@startuml design
+@startuml test_runner_listener_design
 abstract class Runner
 interface TestRunnerListener {
     onTestCaseStart()
@@ -128,7 +128,7 @@ interface TestRunnerListener {
 Runner *--> TestRunnerListener
 @enduml
 
-@startuml test_objects
+@startuml test_entities
 
 entity (TestTaskSpec)
 entity (TestTask)
@@ -141,7 +141,7 @@ TestTask *--> TestRun: contain a list of
 TestRun *--> AndroidTestUnit: contain a list of
 @enduml
 
-@startuml test_objects
+@startuml test_object_relationships
 
 entity (TestTaskSpec)
 entity (TestTask)

build.gradle

@@ -88,4 +88,19 @@ task packageWindowsInstaller(type: Zip) {
     from 'agent/agent_installer/Windows'
     archiveName 'Hydra_Agent_Installer_Windows.zip'
     destinationDir file('build/installer')
+}
+import com.microsoft.hydralab.compile.UMLImageGenerator
+
+task generateUMLImage(group: 'documentation') {
+    doFirst {
+        def scanningDirList = ['agent/doc/UML']
+        def outputDir = new File(projectDir, 'docs/images/UML')
+
+        def generator = new UMLImageGenerator()
+        scanningDirList.each {
+            fileTree(new File(projectDir, it)).filter { it.name.endsWith(".puml") }.files.each {
+                generator.generateUMLImageFromFile(it.absoluteFile, outputDir)
+            }
+        }
+    }
 }

buildSrc/build.gradle

@@ -0,0 +1,10 @@
+repositories {
+    mavenLocal()
+    mavenCentral()
+}
+
+dependencies {
+    implementation gradleApi()
+    implementation 'net.sourceforge.plantuml:plantuml:1.2021.9'
+    testImplementation group: 'junit', name: 'junit', version: '4.12'
+}

buildSrc/src/main/java/com/microsoft/hydralab/compile/UMLImageGenerator.java

@@ -0,0 +1,33 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+package com.microsoft.hydralab.compile;
+
+import net.sourceforge.plantuml.FileFormat;
+import net.sourceforge.plantuml.FileFormatOption;
+import net.sourceforge.plantuml.GeneratedImage;
+import net.sourceforge.plantuml.SourceFileReader;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.List;
+
+public class UMLImageGenerator {
+    public void generateUMLImageFromFile(File source) throws IOException {
+        generateUMLImageFromFile(source, source.getAbsoluteFile().getParentFile(), false);
+    }
+
+    public void generateUMLImageFromFile(File source, File outputDir) throws IOException {
+        generateUMLImageFromFile(source, outputDir, false);
+    }
+
+    public void generateUMLImageFromFile(File source, File outputDir, boolean svg) throws IOException {
+        if (!source.exists()) throw new RuntimeException(source.getAbsolutePath() + " file doesn't exist");
+
+        SourceFileReader reader = svg ?
+                new SourceFileReader(source, outputDir, new FileFormatOption(FileFormat.SVG)) :
+                new SourceFileReader(source, outputDir);
+
+        List<GeneratedImage> list = reader.getGeneratedImages();
+        System.out.printf("Successfully generated %d UML images.\n", list.size());
+    }
+}

buildSrc/src/test/java/com/microsoft/hydralab/compile/TestUMLGeneration.java

@@ -0,0 +1,9 @@
+package com.microsoft.hydralab.compile;
+
+import org.junit.Test;
+
+public class TestUMLGeneration {
+    @Test
+    public void emptyTest() {
+    }
+}