#558 When an entity's title changes, update its filesystem path

Author: dmcassel

quick-start/src/main/java/com/marklogic/quickstart/service/EntityManagerService.java

@@ -156,18 +156,41 @@ public EntityModel createEntity(String projectDir, EntityModel newEntity) throws
     public EntityModel saveEntity(EntityModel entity) throws IOException {
         JsonNode node = entity.toJson();
         ObjectMapper objectMapper = new ObjectMapper();
-        String filename = entity.getFilename();
-        if (filename == null) {
-            String title = entity.getInfo().getTitle();
+        String fullpath = entity.getFilename();
+        String title = entity.getInfo().getTitle();
+
+        if (fullpath == null) {
             Path dir = Paths.get(envConfig().getProjectDir(), PLUGINS_DIR, ENTITIES_DIR, title);
             if (!dir.toFile().exists()) {
                 dir.toFile().mkdirs();
             }
-            filename = Paths.get(dir.toString(), title + ENTITY_FILE_EXTENSION).toString();
+            fullpath = Paths.get(dir.toString(), title + ENTITY_FILE_EXTENSION).toString();
         }
+        else {
+            String filename = new File(fullpath).getName();
+            String entityFromFilename = filename.substring(0, filename.indexOf(ENTITY_FILE_EXTENSION));
+            if (!entityFromFilename.equals(entity.getName())) {
+                // The entity name was changed since the files were created. Update
+                // the path.
+
+                // Update the name of the entity definition file
+                File origFile = new File(fullpath);
+                File newFile = new File(origFile.getParent() + File.separator + title + ENTITY_FILE_EXTENSION);
+                origFile.renameTo(newFile);
+
+                // Update the directory name
+                File origDirectory = new File(origFile.getParent());
+                File newDirectory = new File(origDirectory.getParent() + File.separator + title);
+                origDirectory.renameTo(newDirectory);
+
+                fullpath = newDirectory.getAbsolutePath() + File.separator + title + ENTITY_FILE_EXTENSION;
+                entity.setFilename(fullpath);
+            }
+        }
+
 
         String json = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(node);
-        FileUtils.writeStringToFile(new File(filename), json);
+        FileUtils.writeStringToFile(new File(fullpath), json);
 
         return entity;
     }

quick-start/src/test/java/com/marklogic/quickstart/service/EntityManagerServiceTest.java

@@ -1,5 +1,7 @@
 package com.marklogic.quickstart.service;
 
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.marklogic.hub.HubConfig;
 import com.marklogic.hub.HubTestBase;
 import com.marklogic.hub.flow.CodeFormat;
@@ -31,6 +33,7 @@
 public class EntityManagerServiceTest extends HubTestBase {
 
     private static String ENTITY = "test-entity";
+    private static String ENTITY2 = "test-entity2";
     private static Path projectDir = Paths.get(".", PROJECT_PATH);
 
     @Autowired
@@ -112,7 +115,23 @@ public void getEntities() throws IOException {
     }
 
     @Test
-    public void saveEntity() {
+    public void saveEntity() throws IOException {
+        Path entityDir = projectDir.resolve("plugins/entities/" + ENTITY);
+        String entityFilename = ENTITY2 + EntityManagerService.ENTITY_FILE_EXTENSION;
+
+        JsonNode node = getJsonFromResource(entityFilename);
+
+        EntityModel entity = EntityModel.fromJson(entityFilename, node);
+        entity.setFilename(entityDir.resolve(entityFilename).toString());
+
+        entityMgrService.saveEntity(entity);
+
+        List<EntityModel> entities = entityMgrService.getEntities();
+
+        Assert.assertEquals(2, entities.size());
+        String[] expected = {ENTITY, ENTITY2};
+        String[] actual = { entities.get(0).getName(), entities.get(1).getName() };
+        Assert.assertArrayEquals(expected, actual);
     }
 
     @Test
@@ -157,4 +176,39 @@ public void getFlowByWrongType() throws IOException {
         Assert.assertNull(flow);
     }
 
+    /**
+     * Addresses https://github.com/marklogic-community/marklogic-data-hub/issues/558.
+     */
+    @Test
+    public void changeEntityName() throws IOException {
+        final String RENAMED_ENTITY = "renamed-entity";
+
+        // Get the original entity
+        EntityModel entity = entityMgrService.getEntity(ENTITY);
+
+        // Convert to String and change the title (the UI just changes the title property)
+        String strEntity = entity.toJson().toString();
+        strEntity = strEntity.replaceFirst("\"title\"\\s*:\\s*\"test-entity\"", "\"title\" : \"" + RENAMED_ENTITY + "\"");
+        strEntity = strEntity.replaceFirst("\"test-entity\"\\s*:", "\"" + RENAMED_ENTITY + "\" :");
+
+        // Convert back to JsonNode
+        ObjectMapper mapper = new ObjectMapper();
+        JsonNode renamed = mapper.readTree(strEntity);
+        EntityModel renamedEntity = EntityModel.fromJson(entity.getFilename(), renamed);
+
+        // Save the renamedEntity
+        entityMgrService.saveEntity(renamedEntity);
+
+        List<EntityModel> entities = entityMgrService.getEntities();
+        Assert.assertEquals(1, entities.size());
+
+        // TODO: try to load the flows, which will fail.
+        final String FLOW_NAME = "sjs-json-input-flow";
+        List<FlowModel> inputFlows = entities.get(0).getInputFlows();
+
+        Assert.assertEquals(RENAMED_ENTITY, inputFlows.get(0).entityName);
+        Assert.assertEquals(FLOW_NAME, inputFlows.get(0).flowName);
+        Assert.assertEquals(FlowType.INPUT, inputFlows.get(0).flowType);
+
+    }
 }

quick-start/src/test/resources/test-entity2.entity.json

@@ -0,0 +1,15 @@
+{
+  "info" : {
+    "title" : "test-entity2",
+    "version" : "0.0.1"
+  },
+  "definitions" : {
+    "test-entity2" : {
+      "required" : [ ],
+      "rangeIndex" : [ ],
+      "wordLexicon" : [ ],
+      "properties" : {
+      }
+    }
+  }
+}