O3-3433: SDK Command: Add dependencies to distro.properties

integration-tests/src/test/java/org/openmrs/maven/plugins/AddDependencyTest.java

@@ -0,0 +1,128 @@
+package org.openmrs.maven.plugins;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.openmrs.maven.plugins.model.DistroProperties;
+import org.openmrs.maven.plugins.utility.DistroHelper;
+
+import java.io.File;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+
+public class AddDependencyTest extends AbstractSdkIntegrationTest {
+
+    private String distroFile;
+
+    @Before
+    public void setUp() {
+        distroFile = testDirectory + File.separator + "add-dependency" + File.separator + "openmrs-distro.properties";
+    }
+
+    @Test
+    public void shouldAddOmodDependency() throws Exception {
+        addTaskParam("distro", distroFile);
+        addTaskParam("type", "OMOD");
+        addTaskParam("groupId", "org.openmrs.module");
+        addTaskParam("artifactId", "webservices.rest");
+        addTaskParam("version", "2.30.0");
+
+        executeTask("add-dependency");
+        assertSuccess();
+
+        DistroProperties distroProperties = DistroHelper.getDistroPropertiesFromFile(new File(distroFile));
+        assertNotNull(distroProperties);
+        assertTrue(distroProperties.getAllKeys().contains("omod.webservices.rest"));
+        assertEquals(distroProperties.getParam("omod.webservices.rest"), "2.30.0");
+    }
+
+    @Test
+    public void shouldAddSpaDependency() throws Exception {
+        addTaskParam("distro", distroFile);
+        addTaskParam("type", "SPA");
+        addTaskParam("moduleName", "@openmrs/esm-system-admin-app");
+        addTaskParam("version", "4.0.3");
+
+        executeTask("add-dependency");
+        assertSuccess();
+
+        DistroProperties distroProperties = DistroHelper.getDistroPropertiesFromFile(new File(distroFile));
+        assertNotNull(distroProperties);
+
+        assertTrue(distroProperties.getAllKeys().contains("spa.frontendModules.@openmrs/esm-system-admin-app"));
+        assertEquals(distroProperties.getParam("spa.frontendModules.@openmrs/esm-system-admin-app"), "4.0.3");
+    }
+
+    @Test
+    public void shouldAddOwaDependency() throws Exception {
+        addTaskParam("distro", distroFile);
+        addTaskParam("type", "OWA");
+        addTaskParam("artifactId", "sysadmin");
+        addTaskParam("version", "1.2.0");
+
+        executeTask("add-dependency");
+        assertSuccess();
+
+        DistroProperties distroProperties = DistroHelper.getDistroPropertiesFromFile(new File(distroFile));
+        assertNotNull(distroProperties);
+
+        assertTrue(distroProperties.getAllKeys().contains("owa.sysadmin"));
+        assertEquals(distroProperties.getParam("owa.sysadmin"), "1.2.0");
+    }
+
+    @Test
+    public void shouldAddWarDependency() throws Exception {
+        addTaskParam("distro", distroFile);
+        addTaskParam("type", "WAR");
+        addTaskParam("version", "2.6.1");
+
+        executeTask("add-dependency");
+        assertSuccess();
+
+        DistroProperties distroProperties = DistroHelper.getDistroPropertiesFromFile(new File(distroFile));
+        assertNotNull(distroProperties);
+
+        assertTrue(distroProperties.getAllKeys().contains("war.openmrs"));
+        assertEquals(distroProperties.getParam("war.openmrs"), "2.6.1");
+    }
+
+    @Test
+    public void shouldAddCustomDependencyIfTypeIsNotSpecified() throws Exception {
+        addTaskParam("distro", distroFile);
+        addTaskParam("property", "custom.property");
+        addTaskParam("version", "1.2.3");
+
+        executeTask("add-dependency");
+        assertSuccess();
+
+        DistroProperties distroProperties = DistroHelper.getDistroPropertiesFromFile(new File(distroFile));
+        assertTrue(distroProperties.getAllKeys().contains("custom.property"));
+        assertEquals(distroProperties.getParam("custom.property"), "1.2.3");
+
+    }
+
+    @Test
+    public void shouldOverrideIfPropertyAlreadyExists() throws Exception {
+        DistroProperties distroProperties = DistroHelper.getDistroPropertiesFromFile(new File(distroFile));
+        assertNotNull(distroProperties);
+        assertTrue(distroProperties.getAllKeys().contains("omod.uiframework"));
+
+        addTaskParam("distro", distroFile);
+        addTaskParam("type", "OMOD");
+        addTaskParam("groupId", "org.openmrs.module");
+        addTaskParam("artifactId", "uiframework");
+        addTaskParam("version", "2.30.0");
+
+        executeTask("add-dependency");
+        assertSuccess();
+
+        distroProperties = DistroHelper.getDistroPropertiesFromFile(new File(distroFile));
+        assertNotNull(distroProperties);
+
+        assertTrue(distroProperties.getAllKeys().contains("omod.uiframework"));
+        assertEquals(distroProperties.getParam("omod.uiframework"), "2.30.0");
+    }
+
+
+}

integration-tests/src/test/resources/integration-test/add-dependency/openmrs-distro.properties

@@ -0,0 +1,3 @@
+#Mon Aug 19 16:25:48 IST 2024
+name=Ref 3.x distro
+omod.uiframework=3.6

maven-plugin/src/main/java/org/openmrs/maven/plugins/AddDependency.java

@@ -0,0 +1,157 @@
+package org.openmrs.maven.plugins;
+
+import org.apache.commons.lang.StringUtils;
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugin.MojoFailureException;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.Parameter;
+import org.openmrs.maven.plugins.model.Artifact;
+import org.openmrs.maven.plugins.model.DistroProperties;
+
+import org.openmrs.maven.plugins.utility.NPMHelper;
+import org.openmrs.maven.plugins.utility.SDKConstants;
+
+import java.io.File;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Properties;
+
+@Mojo(name = "add-dependency", requiresProject = false)
+public class AddDependency extends AbstractTask {
+
+    /**
+     *  Path to the openmrs-distro.properties file to modify
+     */
+    @Parameter(property = "distro")
+    private String distro;
+
+    /**
+     * Type of the dependency to add (OMOD, SPA, OWA, WAR or Custom)
+     */
+    @Parameter(property = "type")
+    private String type;
+
+    /**
+     * Maven group id of the dependency
+     */
+    @Parameter(property = "groupId")
+    private String groupId;
+
+    /**
+     * Maven artifact id of the dependency
+     */
+    @Parameter(property = "artifactId")
+    private String artifactId;
+
+    /**
+     * Version of the dependency
+     */
+    @Parameter(property = "version")
+    private String version;
+
+    /**
+     * Name of the frontend module
+     */
+    @Parameter(property = "moduleName")
+    private String moduleName;
+
+    /**
+     * Name of the custom property
+     */
+    @Parameter(property = "property")
+    private String property;
+
+
+    private final String DEPENDENCY_TYPE_PROMPT = "Enter the type of dependency you need to add";
+
+    private final String OMOD_OPTION = "OMOD";
+    private final String SPA_OPTION = "SPA";
+    private final String OWA_OPTION = "OWA";
+    private final String WAR_OPTION = "WAR";
+    private final String CUSTOM_OPTION = "Custom";
+
+
+    @Override
+    public void executeTask() throws MojoExecutionException, MojoFailureException  {
+        if (distro == null) {
+            File userDir = new File(System.getProperty("user.dir"));
+            File distroFile = new File(userDir, DistroProperties.DISTRO_FILE_NAME);
+            if (distroFile.exists()) {
+                distro = distroFile.getAbsolutePath();
+            }
+        }
+
+        if(StringUtils.isBlank(type) && StringUtils.isBlank(property)) {
+            List<String> dependencyTypes = new ArrayList<>(Arrays.asList(OMOD_OPTION, SPA_OPTION, OWA_OPTION, WAR_OPTION, CUSTOM_OPTION));
+            type = wizard.promptForMissingValueWithOptions(DEPENDENCY_TYPE_PROMPT, null, null, dependencyTypes);
+        }
+
+        if(StringUtils.isBlank(type) && StringUtils.isNotBlank(property)) {
+            type = CUSTOM_OPTION;
+        }
+
+        Properties properties = new Properties();
+
+        if(StringUtils.isNotBlank(distro)) {
+            properties = distroHelper.resolveDistroPropertiesForStringSpecifier(distro, versionsHelper).getProperties();
+        }
+
+        switch (type.toUpperCase()) {
+            case OMOD_OPTION:
+                groupId = wizard.promptForValueIfMissingWithDefault(null, groupId, "groupId", Artifact.GROUP_MODULE);
+                artifactId = wizard.promptForValueIfMissing(artifactId, "artifactId");
+                if (StringUtils.isBlank(version)) {
+                    Artifact artifact = new Artifact(artifactId, "1.0", groupId);
+                    List<String> versions = versionsHelper.getSuggestedVersions(artifact, 5);
+                    version = wizard.promptForMissingValueWithOptions("Enter the version", null, null, versions,
+                            "Please specify the module version", null);
+                }
+                properties.setProperty("omod." + artifactId, version);
+                break;
+            case SPA_OPTION:
+                moduleName = wizard.promptForValueIfMissing(moduleName, "frontend module name");
+                if (StringUtils.isBlank(version)) {
+                    List<String> versions = new NPMHelper().getPackageVersions(moduleName, 6);
+                    version = wizard.promptForMissingValueWithOptions("Enter the module version", null, null, versions,
+                            "Please specify the SPA version", null);
+                }
+                properties.setProperty("spa.frontendModules." + moduleName, version);
+                break;
+            case OWA_OPTION:
+                artifactId = wizard.promptForValueIfMissing(artifactId, "OWA name");
+                Artifact artifact = new Artifact(artifactId, "1.0", Artifact.GROUP_OWA);
+                if(StringUtils.isBlank(version)) {
+                    List<String> suggestedVersions = versionsHelper.getSuggestedVersions(artifact, 6);
+                    version = wizard
+                            .promptForMissingValueWithOptions("Which version would you like to deploy?%s", null, "", suggestedVersions,
+                                    "Please specify OWA version", null);
+                }
+                properties.setProperty("owa." + artifactId, version);
+                break;
+            case WAR_OPTION:
+                Artifact platformArtifact = new Artifact(SDKConstants.PLATFORM_ARTIFACT_ID,
+                        SDKConstants.SETUP_DEFAULT_PLATFORM_VERSION, Artifact.GROUP_DISTRO);
+                if(StringUtils.isBlank(version)) {
+                    version =  wizard.promptForPlatformVersion(versionsHelper.getSuggestedVersions(platformArtifact, 5));
+                }
+                properties.setProperty("war.openmrs", version);
+                break;
+            default:
+                property = wizard.promptForValueIfMissing(property, "the property name (ex: omod.legacyui)");
+                version = wizard.promptForValueIfMissing(version, "the property version");
+                properties.setProperty(property, version);
+        }
+
+        DistroProperties distroProperties = new DistroProperties(properties);
+
+        if (StringUtils.isBlank(distro)) {
+            wizard.showMessage("No distro.properpties file is provided. Generating a new openmrs-distro.properties file.");
+            distro = Paths.get(System.getProperty("user.dir"), DistroProperties.DISTRO_FILE_NAME).toString();
+        }
+
+        distroProperties.saveTo(new File(distro).getParentFile());
+    }
+
+}

sdk-commons/src/main/java/org/openmrs/maven/plugins/model/DistroProperties.java

@@ -263,6 +263,10 @@ public Set<Object> getAllKeys() {
         return properties.keySet();
     }
 
+    public Properties getProperties() {
+        return properties;
+    }
+
     public List<String> getExclusions() {
         String exclusions = getParam("exclusions");
         if(exclusions == null) {

sdk-commons/src/main/java/org/openmrs/maven/plugins/utility/NPMHelper.java

@@ -0,0 +1,46 @@
+package org.openmrs.maven.plugins.utility;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.apache.http.client.methods.HttpGet;
+import org.apache.http.impl.client.CloseableHttpClient;
+import org.apache.http.impl.client.HttpClients;
+import org.apache.http.util.EntityUtils;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Comparator;
+import java.util.List;
+import java.util.stream.Collectors;
+
+public class NPMHelper {
+
+    private final ObjectMapper objectMapper;
+
+    public NPMHelper() {
+        this.objectMapper = new ObjectMapper();
+    }
+
+    public List<String> getPackageVersions(String packageName, int limit) {
+        return getPackageVersions(packageName).stream()
+                .sorted(Comparator.reverseOrder())
+                .limit(limit)
+                .collect(Collectors.toList());
+    }
+
+    public List<String> getPackageVersions(String packageName) {
+        String url = "https://registry.npmjs.org/" + packageName;
+        List<String> versionSet = new ArrayList<>();
+        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
+            HttpGet request = new HttpGet(url);
+            String jsonResponse = EntityUtils.toString(httpClient.execute(request).getEntity());
+            JsonNode jsonObject = objectMapper.readTree(jsonResponse);
+            JsonNode versions = jsonObject.get("versions");
+
+            versions.fieldNames().forEachRemaining(versionSet::add);
+            return versionSet;
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
+    }
+}