@Test
public void test_write_createsAWebSequenceDiagram() throws Exception {
Model model = workspace.getModel();
SoftwareSystem a = model.addSoftwareSystem("System A", "");
SoftwareSystem b = model.addSoftwareSystem("System B", "");
SoftwareSystem c = model.addSoftwareSystem("System C", "");
a.uses(b, "");
Relationship bc = b.uses(c, "");
bc.setInteractionStyle(InteractionStyle.Asynchronous);
DynamicView view = workspace.getViews().createDynamicView(a, "A description of the diagram");
view.add(a, "Does something using", b);
view.add(b, "Does something then using", c);
webSequenceDiagramsWriter.write(workspace, stringWriter);
assertEquals(
"title System A - Dynamic - A description of the diagram\n"
+ "\n"
+ "System A->System B: Does something using\n"
+ "System B->>System C: Does something then using\n"
+ "\n",
stringWriter.toString());
}
public class ContainerTests extends AbstractWorkspaceTestBase {
private SoftwareSystem softwareSystem =
model.addSoftwareSystem(Location.External, "System", "Description");
private Container container =
softwareSystem.addContainer("Container", "Description", "Some technology");
@Test
public void test_getCanonicalName() {
assertEquals("/System/Container", container.getCanonicalName());
}
@Test
public void test_getCanonicalName_WhenNameContainsASlashCharacter() {
container.setName("Name1/Name2");
assertEquals("/System/Name1Name2", container.getCanonicalName());
}
}
@JsonIgnore
public Model getModel() {
return softwareSystem.getModel();
}
public static void main(String[] args) throws Exception {
Workspace workspace =
new Workspace("Asynchronous example", "An example of an asynchronous system");
Model model = workspace.getModel();
SoftwareSystem mySoftwareSystem =
model.addSoftwareSystem("My software system", "A description of my software system.");
Container microserviceA =
mySoftwareSystem.addContainer("Microservice A", "", "Java and Spring Boot");
microserviceA.addTags(MICROSERVICE_TAG);
Container microserviceB = mySoftwareSystem.addContainer("Microservice B", "", "Ruby");
microserviceB.addTags(MICROSERVICE_TAG);
Container microserviceC = mySoftwareSystem.addContainer("Microservice C", "", "C# .NET");
microserviceC.addTags(MICROSERVICE_TAG);
Container messageBus = mySoftwareSystem.addContainer("Message Bus", "", "RabbitMQ");
messageBus.addTags(MESSAGE_BUS_TAG);
Container databaseB = mySoftwareSystem.addContainer("Database B", "", "MySQL");
databaseB.addTags(DATABASE_TAG);
Container eventStoreC = mySoftwareSystem.addContainer("Event Store C", "", "Event Store");
eventStoreC.addTags(EVENT_STORE_TAG);
microserviceA.uses(messageBus, "Sends business event X to", "", InteractionStyle.Asynchronous);
messageBus.uses(microserviceB, "Sends business event X to", "", InteractionStyle.Asynchronous);
messageBus.uses(microserviceC, "Sends business event X to", "", InteractionStyle.Asynchronous);
microserviceB.uses(databaseB, "Stores data in", "", InteractionStyle.Synchronous);
microserviceB.uses(
messageBus, "Sends confirmations and events to", "", InteractionStyle.Asynchronous);
microserviceC.uses(eventStoreC, "Stores event in", "", InteractionStyle.Synchronous);
microserviceC.uses(messageBus, "Sends confirmation to", "", InteractionStyle.Asynchronous);
messageBus.uses(microserviceA, "Sends confirmation to", "", InteractionStyle.Asynchronous);
ViewSet views = workspace.getViews();
ContainerView containerView = views.createContainerView(mySoftwareSystem);
containerView.addAllElements();
DynamicView dynamicView = views.createDynamicView(mySoftwareSystem, "Business event X");
dynamicView.add(microserviceA, messageBus);
dynamicView.startChildSequence();
dynamicView.add(messageBus, microserviceB);
dynamicView.add(microserviceB, databaseB);
dynamicView.add(microserviceB, "Sends business event Y to", messageBus);
dynamicView.add(microserviceB, "Sends confirmation to", messageBus);
dynamicView.add(messageBus, microserviceA);
dynamicView.endChildSequence();
dynamicView.startChildSequence();
dynamicView.add(messageBus, microserviceC);
dynamicView.add(microserviceC, eventStoreC);
dynamicView.add(microserviceC, messageBus);
dynamicView.add(messageBus, microserviceA);
dynamicView.endChildSequence();
views
.getConfiguration()
.getStyles()
.add(new ElementStyle(Tags.ELEMENT, null, null, null, null, null, Shape.RoundedBox));
views
.getConfiguration()
.getStyles()
.add(new ElementStyle(MESSAGE_BUS_TAG, 1600, null, "#FFBF00", "#000000", null));
views
.getConfiguration()
.getStyles()
.add(new ElementStyle(MICROSERVICE_TAG, null, null, "#FACC2E", "#000000", null, null));
views
.getConfiguration()
.getStyles()
.add(
new ElementStyle(DATABASE_TAG, null, null, "#F5DA81", "#000000", null, Shape.Cylinder));
views
.getConfiguration()
.getStyles()
.add(
new ElementStyle(
EVENT_STORE_TAG, null, null, "#F5DA81", "#000000", null, Shape.Cylinder));
views
.getConfiguration()
.getStyles()
.add(new RelationshipStyle(Tags.ASYNCHRONOUS, null, null, true, null, null, null, null));
views
.getConfiguration()
.getStyles()
.add(new RelationshipStyle(Tags.SYNCHRONOUS, null, null, false, null, null, null, null));
JsonWriter jsonWriter = new JsonWriter(true);
StringWriter stringWriter = new StringWriter();
jsonWriter.write(workspace, stringWriter);
System.out.println(stringWriter.toString());
StructurizrClient client =
new StructurizrClient("https://api.structurizr.com", "key", "secret");
client.mergeWorkspace(4241, workspace);
}
public static void main(String[] args) throws Exception {
Workspace workspace =
new Workspace(
"Self-Driving Car System",
"Case study for Nate Schutta's modeling workshop at the O'Reilly Software Architecture Conference 2015");
Model model = workspace.getModel();
// create the model
SoftwareSystem selfDrivingCarSystem =
model.addSoftwareSystem(
Location.Internal,
"Self-Driving Car System",
"Central system for storing information about self-driving cars.");
SoftwareSystem selfDrivingCar =
model.addSoftwareSystem("Self-Driving Car", "Our own self-driving cars");
selfDrivingCar.uses(
selfDrivingCarSystem,
"Sends VIN and status information (battery level, health of engine, location, etc) to");
Person carOwner = model.addPerson("Car Owner", "The owner of a self-driving car");
carOwner.uses(
selfDrivingCarSystem, "Gets information from and makes requests (e.g. summon car) to");
carOwner.uses(selfDrivingCar, "Owns and drives");
Person auditor = model.addPerson("Auditor", "Audits access to customer data");
auditor.uses(selfDrivingCarSystem, "Views audit information about customer data access from");
Person dataScientist = model.addPerson("Data Scientist", "Mines self-driving car data");
dataScientist.uses(
selfDrivingCarSystem,
"Mines and produces reports about self-driving cars and their usage with");
Person developer =
model.addPerson(
"Developer", "Builds and maintains the software used in the self-driving cars");
developer.uses(selfDrivingCarSystem, "Send software updates for cars to");
selfDrivingCarSystem.uses(
selfDrivingCar, "Sends software updates and requests (e.g. drive to location) to");
SoftwareSystem activeDirectory =
model.addSoftwareSystem(
"Active Directory",
"Provides enterprise-wide authorisationa and authentication services");
selfDrivingCarSystem.uses(activeDirectory, "uses");
Container mobileApp =
selfDrivingCarSystem.addContainer(
"Mobile App",
"Allows car owners to view information about and make requests to their car",
"Apple iOS, Android and Windows Phone");
carOwner.uses(mobileApp, "Views information from and makes requests to");
Container browser =
selfDrivingCarSystem.addContainer(
"Web Browser",
"Allows car owners to view information about and make requests to their car",
"Apple iOS, Android and Windows Phone");
carOwner.uses(browser, "Views information from and makes requests to");
Container webApp =
selfDrivingCarSystem.addContainer(
"Web Application", "Hosts the browser-based web application", "Apache Tomcat");
browser.uses(webApp, "uses");
Container apiServer =
selfDrivingCarSystem.addContainer(
"API Server",
"Provides an API to get information from and make requests to cars",
"Node.js");
mobileApp.uses(apiServer, "uses [JSON/HTTPS]");
browser.uses(apiServer, "uses [JSON/HTTPS]");
Container customerService =
selfDrivingCarSystem.addContainer(
"Customer Service", "Provides information and behaviour related to customers", "Ruby");
Container selfDrivingCarService =
selfDrivingCarSystem.addContainer(
"Self-Driving Service",
"Provides information and behaviour related to self-driving cars",
"Scala");
Container coreDataStore =
selfDrivingCarSystem.addContainer(
"Core Data Store",
"Stores all data relating to self-driving cars and their owners",
"MySQL");
Container dataReporting =
selfDrivingCarSystem.addContainer(
"Data Reporting", "Allows users to report and mine data", "Hadoop");
dataScientist.uses(dataReporting, "Does science with data from");
auditor.uses(dataReporting, "Looks at audit information from");
developer.uses(selfDrivingCarService, "Pushes updates to");
selfDrivingCarService.uses(selfDrivingCar, "Pushes updates to");
selfDrivingCarService.uses(dataReporting, "Sends events to");
customerService.uses(dataReporting, "Sends events to");
selfDrivingCarService.uses(coreDataStore, "Reads from and writes to");
customerService.uses(coreDataStore, "Reads from and writes to");
apiServer.uses(selfDrivingCarService, "uses [JSON/HTTPS]");
apiServer.uses(customerService, "uses [JSON/HTTPS]");
selfDrivingCar.uses(
selfDrivingCarService,
"Sends VIN and status information (battery level, health of engine, location, etc) to");
dataReporting.uses(activeDirectory, "uses");
// create some views
ViewSet viewSet = workspace.getViews();
SystemContextView contextView = viewSet.createContextView(selfDrivingCarSystem);
contextView.setPaperSize(PaperSize.Slide_4_3);
contextView.addAllElements();
ContainerView containerView = viewSet.createContainerView(selfDrivingCarSystem);
containerView.setPaperSize(PaperSize.A3_Landscape);
containerView.addAllElements();
// tag and style some elements
selfDrivingCarSystem.addTags("System Under Construction");
viewSet
.getConfiguration()
.getStyles()
.add(new ElementStyle(Tags.ELEMENT, 600, 450, null, null, 40));
viewSet
.getConfiguration()
.getStyles()
.add(new ElementStyle("System Under Construction", null, null, "#041F37", "#ffffff", null));
viewSet
.getConfiguration()
.getStyles()
.add(new ElementStyle(Tags.SOFTWARE_SYSTEM, null, null, "#2A4E6E", "#ffffff", null));
viewSet
.getConfiguration()
.getStyles()
.add(new ElementStyle(Tags.PERSON, null, null, "#728da5", "white", 40));
viewSet
.getConfiguration()
.getStyles()
.add(new RelationshipStyle(Tags.RELATIONSHIP, 5, null, null, null, 40, 500, null));
contextView.setPaperSize(PaperSize.Slide_4_3);
// upload it to structurizr.com
StructurizrClient structurizrClient =
new StructurizrClient("https://api.structurizr.com", "key", "secret");
structurizrClient.mergeWorkspace(271, workspace);
}