Value Impact Map generator (#356)

ContextMapper · Aug 13, 2024 · 15d8b2a · 15d8b2a
1 parent e9161d2
commit 15d8b2a
Show file tree

Hide file tree

Showing 20 changed files with 1,036 additions and 32 deletions.
diff --git a/...tests/integ-test-files/generators/plantuml/value-impact-map-diagram-generation-test-1.cml b/...tests/integ-test-files/generators/plantuml/value-impact-map-diagram-generation-test-1.cml
@@ -0,0 +1,21 @@
+BoundedContext SameDayDelivery
+
+Stakeholders of SameDayDelivery {
+	StakeholderGroup Drivers
+}
+
+ValueRegister SD_Values for SameDayDelivery {
+
+	Value WorkLifeBalance {
+		isCore 
+		demonstrator "Drivers value a healthy work-life-balance"
+		Stakeholder Drivers {
+			priority HIGH
+			impact HIGH
+			consequences
+				bad "SDD will harm work-life-balance of drivers"
+				action "hire more drivers" ACT	
+		}
+	}	
+
+}
diff --git a/...tests/integ-test-files/generators/plantuml/value-impact-map-diagram-generation-test-2.cml b/...tests/integ-test-files/generators/plantuml/value-impact-map-diagram-generation-test-2.cml
@@ -0,0 +1,13 @@
+
+Stakeholders {
+	StakeholderGroup Drivers
+}
+
+ValueRegister SD_Values {
+
+	Value WorkLifeBalance {
+		Stakeholder Drivers {
+		}
+	}	
+
+}
diff --git a/...tests/integ-test-files/generators/plantuml/value-impact-map-diagram-generation-test-3.cml b/...tests/integ-test-files/generators/plantuml/value-impact-map-diagram-generation-test-3.cml
@@ -0,0 +1,21 @@
+BoundedContext SameDayDelivery
+
+Stakeholders of SameDayDelivery {
+	StakeholderGroup Drivers
+}
+
+ValueRegister SD_Values for SameDayDelivery {
+
+	Value WorkLifeBalance {
+		isCore 
+		demonstrator "Drivers value a healthy work-life-balance"
+		Stakeholder Drivers {
+			priority HIGH
+			impact HIGH
+			consequences
+				bad "SDD will harm work-life-balance of drivers"
+				action "hire more drivers" ACT	
+		}
+	}	
+
+}
diff --git a/...tests/integ-test-files/generators/plantuml/value-impact-map-diagram-generation-test-4.cml b/...tests/integ-test-files/generators/plantuml/value-impact-map-diagram-generation-test-4.cml
@@ -0,0 +1,25 @@
+
+Stakeholders {
+	StakeholderGroup Customers_and_Shoppers {
+		Stakeholder Shoppers_in_Emergency_Situations
+		Stakeholder Others
+	}
+}
+
+ValueRegister SD_Values {
+
+	ValueCluster Autonomy {
+		core AUTONOMY
+		demonstrator "customer values potentially increased freedom"
+		demonstrator "delivery staff's freedom might suffer because of work-life-balance"
+
+		Stakeholder Customers_and_Shoppers {
+			priority HIGH
+			impact MEDIUM
+			consequences
+				good "increased freedom"
+		}
+
+	}	
+
+}
diff --git a/...tests/integ-test-files/generators/plantuml/value-impact-map-diagram-generation-test-5.cml b/...tests/integ-test-files/generators/plantuml/value-impact-map-diagram-generation-test-5.cml
@@ -0,0 +1,36 @@
+
+Stakeholders {
+	StakeholderGroup Customers_and_Shoppers {
+		Stakeholder Shoppers_in_Emergency_Situations
+		Stakeholder Others
+	}
+	StakeholderGroup Delivery_Staff_of_Suppliers
+}
+
+ValueRegister SD_Values {
+
+	ValueCluster Autonomy {
+		core AUTONOMY
+		demonstrator "customer values potentially increased freedom"
+		demonstrator "delivery staff's freedom might suffer because of work-life-balance"
+
+		Value Freedom {
+			Stakeholder Customers_and_Shoppers {
+				priority HIGH
+				impact MEDIUM
+				consequences
+					good "increased freedom"
+			}
+
+			Stakeholder Delivery_Staff_of_Suppliers {
+				priority HIGH
+				impact HIGH
+				consequences
+					bad "work-life-balance"
+					good "tbd" 
+
+			}
+		}
+	}	
+
+}
diff --git a/...tests/integ-test-files/generators/plantuml/value-impact-map-diagram-generation-test-6.cml b/...tests/integ-test-files/generators/plantuml/value-impact-map-diagram-generation-test-6.cml
@@ -0,0 +1,45 @@
+
+Stakeholders {
+	StakeholderGroup Customers_and_Shoppers {
+		Stakeholder Shoppers_in_Emergency_Situations
+		Stakeholder Others
+	}
+	StakeholderGroup Delivery_Staff_of_Suppliers
+}
+
+ValueRegister SD_Values {
+
+	ValueCluster Autonomy {
+		core AUTONOMY
+		demonstrator "customer values potentially increased freedom"
+		demonstrator "delivery staff's freedom might suffer because of work-life-balance"
+
+		Value Freedom {
+			Stakeholder Customers_and_Shoppers {
+				priority HIGH
+				impact MEDIUM
+				consequences
+					good "increased freedom"
+			}
+
+			Stakeholder Delivery_Staff_of_Suppliers {
+				priority HIGH
+				impact HIGH
+				consequences
+					bad "work-life-balance"
+					good "tbd" 
+
+			}
+
+		}
+		Value Sustainability {
+			Stakeholder Customers_and_Shoppers  {
+				priority HIGH
+				impact LOW
+				consequences
+					bad "fostering unsustainable behavior (always ordering last minute)"
+			}
+		}
+	}	
+
+}
diff --git a/...mapper.dsl.tests/src/org/contextmapper/dsl/generators/plantuml/PlantUMLGeneratorTest.java b/...mapper.dsl.tests/src/org/contextmapper/dsl/generators/plantuml/PlantUMLGeneratorTest.java
@@ -67,7 +67,8 @@ void canCreatePlantUMLDiagramFiles() {
 
 		// when
 		IFileSystemAccess2Mock filesystem = new IFileSystemAccess2Mock();
-		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem, new IGeneratorContextMock());
+		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem,
+				new IGeneratorContextMock());
 
 		// then
 		assertTrue(filesystem.getGeneratedFilesSet().contains("testmodel_ContextMap.puml"));
@@ -85,7 +86,8 @@ void canCreateBoundedContextClassDiagramsWithoutContextMap() {
 
 		// when
 		IFileSystemAccess2Mock filesystem = new IFileSystemAccess2Mock();
-		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem, new IGeneratorContextMock());
+		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem,
+				new IGeneratorContextMock());
 
 		// then
 		assertTrue(filesystem.getGeneratedFilesSet().contains("testmodel_BC_TestContext.puml"));
@@ -108,7 +110,8 @@ void canCreatePlantUMLDiagrmFiles4SubdomainIfEntitiesAvailable() {
 
 		// when
 		IFileSystemAccess2Mock filesystem = new IFileSystemAccess2Mock();
-		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem, new IGeneratorContextMock());
+		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem,
+				new IGeneratorContextMock());
 
 		// then
 		assertFalse(filesystem.getGeneratedFilesSet().contains("testmodel_SD_TestSubdomain1.puml"));
@@ -118,100 +121,133 @@ void canCreatePlantUMLDiagrmFiles4SubdomainIfEntitiesAvailable() {
 	@Test
 	void canCreateStateDiagram4ApplicationFlowIfAvailable() throws IOException {
 		// given
-		ContextMappingModel model = getOriginalResourceOfTestCML("state-diagram-generation-flow-test.cml").getContextMappingModel();
+		ContextMappingModel model = getOriginalResourceOfTestCML("state-diagram-generation-flow-test.cml")
+				.getContextMappingModel();
 
 		// when
 		IFileSystemAccess2Mock filesystem = new IFileSystemAccess2Mock();
-		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem, new IGeneratorContextMock());
+		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem,
+				new IGeneratorContextMock());
 
 		// then
-		assertTrue(filesystem.getGeneratedFilesSet().contains("testmodel_BC_InsuranceQuotes_QuoteFlow_StateDiagram.puml"));
+		assertTrue(
+				filesystem.getGeneratedFilesSet().contains("testmodel_BC_InsuranceQuotes_QuoteFlow_StateDiagram.puml"));
 	}
 
 	@Test
 	void canCreateClass4AggregateIfAvailable() throws IOException {
 		// given
-		ContextMappingModel model = getOriginalResourceOfTestCML("class-diagram-generation-aggregate-test-1.cml").getContextMappingModel();
+		ContextMappingModel model = getOriginalResourceOfTestCML("class-diagram-generation-aggregate-test-1.cml")
+				.getContextMappingModel();
 
 		// when
 		IFileSystemAccess2Mock filesystem = new IFileSystemAccess2Mock();
-		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem, new IGeneratorContextMock());
+		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem,
+				new IGeneratorContextMock());
 
 		// then
 		assertTrue(filesystem.getGeneratedFilesSet().contains("testmodel_BC_InsuranceQuotes_QuoteRequest.puml"));
 	}
-	
+
 	@Test
 	void canCreateClass4ModuleIfAvailable() throws IOException {
 		// given
-		ContextMappingModel model = getOriginalResourceOfTestCML("class-diagram-generation-module-test-1.cml").getContextMappingModel();
+		ContextMappingModel model = getOriginalResourceOfTestCML("class-diagram-generation-module-test-1.cml")
+				.getContextMappingModel();
 
 		// when
 		IFileSystemAccess2Mock filesystem = new IFileSystemAccess2Mock();
-		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem, new IGeneratorContextMock());
+		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem,
+				new IGeneratorContextMock());
 
 		// then
 		assertTrue(filesystem.getGeneratedFilesSet().contains("testmodel_BC_InsuranceQuotes_QuoteRequest.puml"));
 	}
-	
+
 	@Test
 	void canCreateStateDiagram4AggregateIfAvailable() throws IOException {
 		// given
-		ContextMappingModel model = getOriginalResourceOfTestCML("state-diagram-generation-aggregate-test-1.cml").getContextMappingModel();
+		ContextMappingModel model = getOriginalResourceOfTestCML("state-diagram-generation-aggregate-test-1.cml")
+				.getContextMappingModel();
 
 		// when
 		IFileSystemAccess2Mock filesystem = new IFileSystemAccess2Mock();
-		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem, new IGeneratorContextMock());
+		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem,
+				new IGeneratorContextMock());
 
 		// then
-		assertTrue(filesystem.getGeneratedFilesSet().contains("testmodel_BC_InsuranceQuotes_QuoteRequest_StateDiagram.puml"));
+		assertTrue(filesystem.getGeneratedFilesSet()
+				.contains("testmodel_BC_InsuranceQuotes_QuoteRequest_StateDiagram.puml"));
 	}
-	
+
 	@Test
 	void canCreateUseCaseDiagram4UseCasesIfAvailable() throws IOException {
 		// given
-		ContextMappingModel model = getOriginalResourceOfTestCML("use-case-diagram-generation-test-1.cml").getContextMappingModel();
+		ContextMappingModel model = getOriginalResourceOfTestCML("use-case-diagram-generation-test-1.cml")
+				.getContextMappingModel();
 
 		// when
 		IFileSystemAccess2Mock filesystem = new IFileSystemAccess2Mock();
-		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem, new IGeneratorContextMock());
+		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem,
+				new IGeneratorContextMock());
 
 		// then
 		assertTrue(filesystem.getGeneratedFilesSet().contains("testmodel_UseCases.puml"));
 	}
-	
+
 	@Test
 	void canCreateSequenceDiagram4UseCaseInteractionsIfAvailable() throws IOException {
 		// given
-		ContextMappingModel model = getOriginalResourceOfTestCML("use-case-diagram-generation-test-1.cml").getContextMappingModel();
+		ContextMappingModel model = getOriginalResourceOfTestCML("use-case-diagram-generation-test-1.cml")
+				.getContextMappingModel();
 
 		// when
 		IFileSystemAccess2Mock filesystem = new IFileSystemAccess2Mock();
-		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem, new IGeneratorContextMock());
+		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem,
+				new IGeneratorContextMock());
 
 		// then
-		assertTrue(filesystem.getGeneratedFilesSet().contains("testmodel_UseCase_Get_paid_for_car_accident_Interactions.puml"));
+		assertTrue(filesystem.getGeneratedFilesSet()
+				.contains("testmodel_UseCase_Get_paid_for_car_accident_Interactions.puml"));
 	}
-	
+
 	@Test
 	void canCreateStakeholderDiagramsIfStakeholdersAreAvailable() throws IOException {
 		// given
-		ContextMappingModel model = getOriginalResourceOfTestCML("stakeholder-diagram-generation-test-1.cml").getContextMappingModel();
-
-		
+		ContextMappingModel model = getOriginalResourceOfTestCML("stakeholder-diagram-generation-test-1.cml")
+				.getContextMappingModel();
+
 		// when
 		IFileSystemAccess2Mock filesystem = new IFileSystemAccess2Mock();
-		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem, new IGeneratorContextMock());
-
+		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem,
+				new IGeneratorContextMock());
+
 		// then
 		assertTrue(filesystem.getGeneratedFilesSet().contains("testmodel_BC_System-of-Interest_StakeholderMap-1.puml"));
 	}
 
+	@Test
+	void canCreateValueImpactMapDiagramsIfValueRegistersAreAvailable() throws IOException {
+		// given
+		ContextMappingModel model = getOriginalResourceOfTestCML("value-impact-map-diagram-generation-test-1.cml")
+				.getContextMappingModel();
+
+		// when
+		IFileSystemAccess2Mock filesystem = new IFileSystemAccess2Mock();
+		this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem,
+				new IGeneratorContextMock());
+
+		// then
+		assertTrue(
+				filesystem.getGeneratedFilesSet().contains("testmodel_ValueRegister_SD_Values_Value-Impact-Map.puml"));
+	}
+
 	@Test
 	void expectExceptionForEmptyResource() {
 		IFileSystemAccess2Mock filesystem = new IFileSystemAccess2Mock();
 		assertThrows(GeneratorInputException.class, () -> {
-			this.generator.doGenerate(new ContextMappingModelResourceMock(null, "testmodel", "cml"), filesystem, new IGeneratorContextMock());
+			this.generator.doGenerate(new ContextMappingModelResourceMock(null, "testmodel", "cml"), filesystem,
+					new IGeneratorContextMock());
 		});
 	}
 
@@ -220,7 +256,8 @@ void expectExceptionForEmptyContextMappingModel() {
 		ContextMappingModel model = ContextMappingDSLFactory.eINSTANCE.createContextMappingModel();
 		IFileSystemAccess2Mock filesystem = new IFileSystemAccess2Mock();
 		assertThrows(GeneratorInputException.class, () -> {
-			this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem, new IGeneratorContextMock());
+			this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem,
+					new IGeneratorContextMock());
 		});
 	}
 
@@ -232,7 +269,8 @@ void expectExceptionIfThereIsOnlyAnEmptyDomain() {
 		model.getDomains().add(emptyDomain);
 		IFileSystemAccess2Mock filesystem = new IFileSystemAccess2Mock();
 		assertThrows(GeneratorInputException.class, () -> {
-			this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem, new IGeneratorContextMock());
+			this.generator.doGenerate(new ContextMappingModelResourceMock(model, "testmodel", "cml"), filesystem,
+					new IGeneratorContextMock());
 		});
 	}