building out VersionPlace to add emissary version info to metadata

src/main/config/emissary.admin.ClassNameInventory.cfg

@@ -19,3 +19,4 @@ ToLowerPlace          = "emissary.place.sample.ToLowerPlace"
 ToUpperPlace          = "emissary.place.sample.ToUpperPlace"
 UnixCommandPlace      = "emissary.place.UnixCommandPlace"
 UnixFilePlace         = "emissary.id.UnixFilePlace"
+VersionPlace          = "emissary.place.VersionPlace"

src/main/config/places.cfg

@@ -3,3 +3,4 @@ PLACE = "@{URL}/ToLowerPlace"
 PLACE = "@{URL}/DropOffPlace"
 PLACE = "@{URL}/UnixFilePlace"
 PLACE = "@{URL}/JsonEscapePlace"
+PLACE = "@{URL}/VersionPlace"

src/main/java/emissary/place/VersionPlace.java

@@ -0,0 +1,78 @@
+package emissary.place;
+
+import emissary.core.IBaseDataObject;
+import emissary.core.ResourceException;
+import emissary.util.Version;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+public class VersionPlace extends ServiceProviderPlace {
+
+    private static final String EMISSARY_VERSION = "EMISSARY_VERSION";
+    private boolean includeDate;
+    private final Version version = new Version();
+    private String formattedVersion;
+
+    /**
+     * Create the place from the specified config file or resource
+     *
+     * @param configInfo the config file or resource to use
+     * @param dir the name of the controlling directory to register with
+     * @param placeLoc string name of this place
+     */
+    public VersionPlace(String configInfo, String dir, String placeLoc) throws IOException {
+        super(configInfo, dir, placeLoc);
+        configurePlace();
+    }
+
+    /**
+     * Create the place from the specified config stream data
+     *
+     * @param configInfo the config file or resource to use
+     * @param dir the name of the controlling directory to register with
+     * @param placeLoc string name of this place
+     */
+    public VersionPlace(InputStream configInfo, String dir, String placeLoc) throws IOException {
+        super(configInfo, dir, placeLoc);
+        configurePlace();
+    }
+
+    /**
+     * Create the place from the specified config stream data
+     *
+     * @param configInfo the config file or resource to use
+     */
+    public VersionPlace(InputStream configInfo) throws IOException {
+        super(configInfo);
+        configurePlace();
+    }
+
+    /**
+     * Create with the default configuration
+     */
+    public VersionPlace() throws IOException {
+        super();
+        configurePlace();
+    }
+
+    private void configurePlace() {
+        includeDate = configG.findBooleanEntry("INCLUDE_DATE", true);
+        formattedVersion = getEmissaryVersion();
+    }
+
+    @Override
+    public void process(IBaseDataObject payload) throws ResourceException {
+        payload.putParameter(EMISSARY_VERSION, formattedVersion);
+    }
+
+    private String getEmissaryVersion() {
+        if (includeDate) {
+            // version with date & time information
+            return version.getVersion() + "-" + version.getTimestamp().replaceAll("\\D", "");
+        } else {
+            // adds just version
+            return version.getVersion();
+        }
+    }
+}

src/main/resources/emissary/place/VersionPlace.cfg

@@ -0,0 +1,8 @@
+PLACE_NAME = "VersionPlace"
+SERVICE_NAME = "VERSION"
+SERVICE_TYPE = "VERIFY"
+SERVICE_DESCRIPTION = "add emissary version to payload"
+SERVICE_COST = 50
+SERVICE_QUALITY = 50
+
+SERVICE_PROXY = "UNKNOWN"

src/test/java/emissary/place/VersionPlaceTest.java

@@ -0,0 +1,64 @@
+package emissary.place;
+
+import emissary.core.DataObjectFactory;
+import emissary.core.IBaseDataObject;
+import emissary.core.ResourceException;
+import emissary.test.core.junit5.UnitTest;
+import emissary.util.Version;
+import emissary.util.io.ResourceReader;
+
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+
+class VersionPlaceTest extends UnitTest {
+    private IBaseDataObject payload;
+    private VersionPlace place;
+    private Version version;
+    private String versionDate;
+
+    @Override
+    @BeforeEach
+    public void setUp() throws IOException {
+        payload = DataObjectFactory.getInstance();
+        version = new Version();
+        versionDate = version.getTimestamp().replaceAll("\\D", "");
+    }
+
+    @Override
+    @AfterEach
+    public void tearDown() throws Exception {
+        super.tearDown();
+        place.shutDown();
+        place = null;
+        payload = null;
+        versionDate = null;
+    }
+
+    @Test
+    void testAddVersionToPayload() throws ResourceException, IOException {
+        // create the place, using the normal class cfg
+        place = new VersionPlace();
+
+        place.process(payload);
+        assertEquals(payload.getStringParameter("EMISSARY_VERSION"), version.getVersion() + "-" + versionDate,
+                "added version should contain the date.");
+    }
+
+    @Test
+    void testAddVersionWithoutDate() throws ResourceException, IOException {
+        // create the place with the test cfg, having INCLUDE_DATE = "false"
+        InputStream is = new ResourceReader().getConfigDataAsStream(this.getClass());
+        place = new VersionPlace(is);
+
+        place.process(payload);
+        assertFalse(payload.getStringParameter("EMISSARY_VERSION").contains(versionDate), "the date should not be added to the version");
+        assertEquals(payload.getStringParameter("EMISSARY_VERSION"), version.getVersion(), "the version should be added");
+    }
+}

src/test/resources/emissary/place/VersionPlaceTest.cfg

@@ -0,0 +1,10 @@
+PLACE_NAME = "VersionPlaceTest"
+SERVICE_NAME = "VERSION_TEST"
+SERVICE_TYPE = "VERIFY"
+SERVICE_DESCRIPTION = "add emissary version to payload"
+SERVICE_COST = 50
+SERVICE_QUALITY = 50
+
+SERVICE_PROXY = "TEST"
+
+INCLUDE_DATE = "false"