doFindComponents() {
18 | return findInterfacesForImplementationClassesWithAnnotation(
19 | org.springframework.stereotype.Component.class,
20 | SPRING_COMPONENT
21 | );
22 | }
23 |
24 | }
--------------------------------------------------------------------------------
/structurizr-spring/src/com/structurizr/analysis/SpringComponentFinderStrategy.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis;
2 |
3 | import com.structurizr.model.Component;
4 |
5 | import java.util.HashSet;
6 | import java.util.LinkedList;
7 | import java.util.List;
8 | import java.util.Set;
9 |
10 | /**
11 | *
12 | * This component finder strategy knows how to find the following Spring components:
13 | *
14 | *
15 | *
16 | * - Spring MVC controllers (classes annotated @Controller)
17 | * - Spring REST controllers (classes annotated @RestController)
18 | * - Spring services (classes annotated @Service)
19 | * - Spring components (classes annotated @Component)
20 | * - Spring repositories (classes annotated @Repository, plus those that extend JpaRepository or CrudRepository)
21 | *
22 | *
23 | *
24 | * By default, non-public types will be ignored so that, for example, you can
25 | * hide repository implementations behind services, as described at
26 | * Whoops! Where did my architecture go.
27 | * You can change this behaviour by passing false to {@link #setIncludePublicTypesOnly(boolean)}.
28 | *
29 | */
30 | public class SpringComponentFinderStrategy extends AbstractSpringComponentFinderStrategy {
31 |
32 | private List componentFinderStrategies = new LinkedList<>();
33 |
34 | public SpringComponentFinderStrategy(SupportingTypesStrategy... strategies) {
35 | super(strategies);
36 | }
37 |
38 | @Override
39 | public void beforeFindComponents() {
40 | super.beforeFindComponents();
41 |
42 | componentFinderStrategies.add(new SpringRestControllerComponentFinderStrategy());
43 | componentFinderStrategies.add(new SpringMvcControllerComponentFinderStrategy());
44 | componentFinderStrategies.add(new SpringServiceComponentFinderStrategy());
45 | componentFinderStrategies.add(new SpringComponentComponentFinderStrategy());
46 | componentFinderStrategies.add(new SpringRepositoryComponentFinderStrategy());
47 |
48 | for (AbstractSpringComponentFinderStrategy componentFinderStrategy : componentFinderStrategies) {
49 | componentFinderStrategy.setIncludePublicTypesOnly(includePublicTypesOnly);
50 | componentFinderStrategy.setComponentFinder(getComponentFinder());
51 | supportingTypesStrategies.forEach(componentFinderStrategy::addSupportingTypesStrategy);
52 | componentFinderStrategy.setDuplicateComponentStrategy(getDuplicateComponentStrategy());
53 | componentFinderStrategy.beforeFindComponents();
54 | }
55 | }
56 |
57 | @Override
58 | protected Set doFindComponents() {
59 | Set components = new HashSet<>();
60 |
61 | for (AbstractComponentFinderStrategy componentFinderStrategy : componentFinderStrategies) {
62 | components.addAll(componentFinderStrategy.findComponents());
63 | }
64 |
65 | return components;
66 | }
67 |
68 | }
--------------------------------------------------------------------------------
/structurizr-spring/src/com/structurizr/analysis/SpringMvcControllerComponentFinderStrategy.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis;
2 |
3 | import com.structurizr.model.Component;
4 |
5 | import java.util.Set;
6 |
7 | /**
8 | * A component finder strategy that finds Spring MVC controllers (classes annotated @Controller).
9 | */
10 | public final class SpringMvcControllerComponentFinderStrategy extends AbstractSpringComponentFinderStrategy {
11 |
12 | public SpringMvcControllerComponentFinderStrategy(SupportingTypesStrategy... strategies) {
13 | super(strategies);
14 | }
15 |
16 | @Override
17 | protected Set doFindComponents() {
18 | return findClassesWithAnnotation(
19 | org.springframework.stereotype.Controller.class,
20 | SPRING_MVC_CONTROLLER,
21 | includePublicTypesOnly
22 | );
23 | }
24 |
25 | }
--------------------------------------------------------------------------------
/structurizr-spring/src/com/structurizr/analysis/SpringRepositoryComponentFinderStrategy.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis;
2 |
3 | import com.structurizr.model.Component;
4 | import com.structurizr.model.Container;
5 | import org.springframework.data.jpa.repository.JpaRepository;
6 | import org.springframework.data.repository.CrudRepository;
7 | import org.springframework.data.repository.Repository;
8 |
9 | import java.lang.reflect.Modifier;
10 | import java.util.HashSet;
11 | import java.util.Set;
12 |
13 | /**
14 | * A component finder strategy for Spring repositories (classes annotated @Repository,
15 | * plus those that extend JpaRepository or CrudRepository).
16 | */
17 | public final class SpringRepositoryComponentFinderStrategy extends AbstractSpringComponentFinderStrategy {
18 |
19 | public SpringRepositoryComponentFinderStrategy(SupportingTypesStrategy... strategies) {
20 | super(strategies);
21 | }
22 |
23 | @Override
24 | protected Set doFindComponents() {
25 | Set components = new HashSet<>();
26 |
27 | components.addAll(findAnnotatedSpringRepositories());
28 | components.addAll(findSpringRepositoryInterfaces());
29 |
30 | return components;
31 | }
32 |
33 | private Set findSpringRepositoryInterfaces() {
34 | Set componentsFound = new HashSet<>();
35 | Set> componentTypes = new HashSet<>();
36 |
37 | Set> types = getTypeRepository().getAllTypes();
38 | for (Class type : types) {
39 | if (type.isInterface()) {
40 | if (
41 | Repository.class.isAssignableFrom(type) ||
42 | JpaRepository.class.isAssignableFrom(type) ||
43 | CrudRepository.class.isAssignableFrom(type)
44 | ) {
45 | componentTypes.add(type);
46 | }
47 | }
48 | }
49 |
50 | for (Class componentType : componentTypes) {
51 | if (!includePublicTypesOnly || Modifier.isPublic(componentType.getModifiers())) {
52 | final Container container = getComponentFinder().getContainer();
53 | Component newComponent = addComponent(
54 | container,
55 | componentType.getSimpleName(),
56 | componentType.getCanonicalName(),
57 | "",
58 | SPRING_REPOSITORY);
59 |
60 |
61 | if (newComponent != null) {
62 | componentsFound.add(newComponent);
63 | }
64 | }
65 | }
66 |
67 | return componentsFound;
68 | }
69 |
70 | private Set findAnnotatedSpringRepositories() {
71 | return findInterfacesForImplementationClassesWithAnnotation(
72 | org.springframework.stereotype.Repository.class, SPRING_REPOSITORY);
73 | }
74 |
75 | }
--------------------------------------------------------------------------------
/structurizr-spring/src/com/structurizr/analysis/SpringRestControllerComponentFinderStrategy.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis;
2 |
3 | import com.structurizr.model.Component;
4 |
5 | import java.util.Set;
6 |
7 | /**
8 | * A component finder strategy that finds Spring REST controllers (classes annotated @RestController).
9 | */
10 | public final class SpringRestControllerComponentFinderStrategy extends AbstractSpringComponentFinderStrategy {
11 |
12 | public SpringRestControllerComponentFinderStrategy(SupportingTypesStrategy... strategies) {
13 | super(strategies);
14 | }
15 |
16 | @Override
17 | protected Set doFindComponents() {
18 | return findClassesWithAnnotation(
19 | org.springframework.web.bind.annotation.RestController.class,
20 | SPRING_REST_CONTROLLER,
21 | includePublicTypesOnly
22 | );
23 | }
24 |
25 | }
--------------------------------------------------------------------------------
/structurizr-spring/src/com/structurizr/analysis/SpringServiceComponentFinderStrategy.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis;
2 |
3 | import com.structurizr.model.Component;
4 |
5 | import java.util.Set;
6 |
7 | /**
8 | * A component finder strategy that finds Spring Services (classes annotated @Service).
9 | */
10 | public final class SpringServiceComponentFinderStrategy extends AbstractSpringComponentFinderStrategy {
11 |
12 | public SpringServiceComponentFinderStrategy(SupportingTypesStrategy... strategies) {
13 | super(strategies);
14 | }
15 |
16 | @Override
17 | protected Set doFindComponents() {
18 | return findInterfacesForImplementationClassesWithAnnotation(
19 | org.springframework.stereotype.Service.class,
20 | SPRING_SERVICE
21 | );
22 | }
23 |
24 | }
--------------------------------------------------------------------------------
/structurizr-spring/src/com/structurizr/analysis/SpringWebServiceEndpointComponentFinderStrategy.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis;
2 |
3 | import com.structurizr.model.Component;
4 |
5 | import java.util.Set;
6 |
7 | /**
8 | * A component finder strategy that finds Spring web service endpoints (classes annotated @Endpoint).
9 | */
10 | public final class SpringWebServiceEndpointComponentFinderStrategy extends AbstractSpringComponentFinderStrategy {
11 |
12 | public SpringWebServiceEndpointComponentFinderStrategy(SupportingTypesStrategy... strategies) {
13 | super(strategies);
14 | }
15 |
16 | @Override
17 | protected Set doFindComponents() {
18 | return findClassesWithAnnotation(
19 | org.springframework.ws.server.endpoint.annotation.Endpoint.class,
20 | SPRING_WEB_SERVICE_ENDPOINT,
21 | includePublicTypesOnly
22 | );
23 | }
24 |
25 | }
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/AbstractSpringComponentFinderStrategyTests.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis;
2 |
3 | import com.structurizr.Workspace;
4 | import com.structurizr.model.Component;
5 | import com.structurizr.model.Container;
6 | import com.structurizr.model.Model;
7 | import com.structurizr.model.SoftwareSystem;
8 | import org.junit.Test;
9 |
10 | import static org.junit.Assert.assertEquals;
11 |
12 | public class AbstractSpringComponentFinderStrategyTests {
13 |
14 | @Test
15 | public void test_findComponents_IgnoresNonPublicTypesByDefault() throws Exception {
16 | Workspace workspace = new Workspace("Name", "Description");
17 | Model model = workspace.getModel();
18 | SoftwareSystem softwareSystem = model.addSoftwareSystem("Name", "Description");
19 | Container container = softwareSystem.addContainer("Name", "Description", "Technology");
20 |
21 | ComponentFinder componentFinder = new ComponentFinder(
22 | container,
23 | "test.AbstractSpringComponentFinderStrategy",
24 | new SpringComponentFinderStrategy()
25 | );
26 | componentFinder.findComponents();
27 |
28 | assertEquals(2, container.getComponents().size());
29 |
30 | Component component = container.getComponentWithName("SomeController");
31 | assertEquals("test.AbstractSpringComponentFinderStrategy.SomeController", component.getType().getType());
32 |
33 | component = container.getComponentWithName("SomePublicRepository");
34 | assertEquals("test.AbstractSpringComponentFinderStrategy.SomePublicRepository", component.getType().getType());
35 | }
36 |
37 | @Test
38 | public void test_findComponents_DoesNotIgnoreNonPublicTypes_WhenConfiguredToIncludeNonPublicTypes() throws Exception {
39 | Workspace workspace = new Workspace("Name", "Description");
40 | Model model = workspace.getModel();
41 | SoftwareSystem softwareSystem = model.addSoftwareSystem("Name", "Description");
42 | Container container = softwareSystem.addContainer("Name", "Description", "Technology");
43 |
44 | SpringComponentFinderStrategy springComponentFinderStrategy = new SpringComponentFinderStrategy();
45 | springComponentFinderStrategy.setIncludePublicTypesOnly(false);
46 | ComponentFinder componentFinder = new ComponentFinder(
47 | container,
48 | "test.AbstractSpringComponentFinderStrategy",
49 | springComponentFinderStrategy
50 | );
51 | componentFinder.findComponents();
52 |
53 | assertEquals(3, container.getComponents().size());
54 |
55 | Component component = container.getComponentWithName("SomeController");
56 | assertEquals("test.AbstractSpringComponentFinderStrategy.SomeController", component.getType().getType());
57 |
58 | component = container.getComponentWithName("SomePublicRepository");
59 | assertEquals("test.AbstractSpringComponentFinderStrategy.SomePublicRepository", component.getType().getType());
60 |
61 | component = container.getComponentWithName("SomeNonPublicRepository");
62 | assertEquals("test.AbstractSpringComponentFinderStrategy.SomeNonPublicRepository", component.getType().getType());
63 | }
64 |
65 | }
66 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/SpringComponentComponentFinderStrategyTests.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis;
2 |
3 | import com.structurizr.Workspace;
4 | import com.structurizr.model.Component;
5 | import com.structurizr.model.Container;
6 | import com.structurizr.model.Model;
7 | import com.structurizr.model.SoftwareSystem;
8 | import org.junit.Test;
9 |
10 | import static org.junit.Assert.assertEquals;
11 |
12 | public class SpringComponentComponentFinderStrategyTests {
13 |
14 | @Test
15 | public void test_findComponents_FindsSpringComponents() throws Exception {
16 | Workspace workspace = new Workspace("Name", "Description");
17 | Model model = workspace.getModel();
18 | SoftwareSystem softwareSystem = model.addSoftwareSystem("Name", "Description");
19 | Container container = softwareSystem.addContainer("Name", "Description", "Technology");
20 |
21 | ComponentFinder componentFinder = new ComponentFinder(
22 | container,
23 | "test.SpringComponentComponentFinderStrategy",
24 | new SpringComponentComponentFinderStrategy()
25 | );
26 | componentFinder.findComponents();
27 |
28 | assertEquals(1, container.getComponents().size());
29 | Component component = container.getComponentWithName("SomeComponent");
30 | assertEquals("test.SpringComponentComponentFinderStrategy.SomeComponent", component.getType().getType());
31 | assertEquals("", component.getDescription());
32 | assertEquals("Spring Component", component.getTechnology());
33 | }
34 |
35 | }
36 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/SpringComponentFinderStrategyTests.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis;
2 |
3 | import com.structurizr.Workspace;
4 | import com.structurizr.model.*;
5 | import org.junit.Before;
6 | import org.junit.Test;
7 |
8 | import java.util.Set;
9 |
10 | import static org.junit.Assert.assertEquals;
11 | import static org.junit.Assert.assertNotNull;
12 | import static org.junit.Assert.fail;
13 |
14 | public class SpringComponentFinderStrategyTests {
15 |
16 | private Container webApplication;
17 |
18 | @Before
19 | public void setUp() {
20 | Workspace workspace = new Workspace("Name", "Description");
21 | Model model = workspace.getModel();
22 | SoftwareSystem softwareSystem = model.addSoftwareSystem("Name", "Description");
23 | webApplication = softwareSystem.addContainer("Name", "Description", "Technology");
24 | }
25 |
26 | @Test
27 | public void test_findComponents() throws Exception {
28 | ComponentFinder componentFinder = new ComponentFinder(
29 | webApplication,
30 | "com.structurizr.analysis.myapp",
31 | new SpringComponentFinderStrategy()
32 | );
33 | componentFinder.findComponents();
34 |
35 | assertEquals(5, webApplication.getComponents().size());
36 | assertEquals(0, webApplication.getComponents().stream().filter(c -> "SomeNonPublicRepository".equals(c.getName())).count());
37 |
38 | Component someMvcController = webApplication.getComponentWithName("SomeController");
39 | assertNotNull(someMvcController);
40 | assertEquals("SomeController", someMvcController.getName());
41 | assertEquals("com.structurizr.analysis.myapp.web.SomeController", someMvcController.getType().getType());
42 | assertEquals(1, someMvcController.getCode().size());
43 |
44 | Component someRestController = webApplication.getComponentWithName("SomeApiController");
45 | assertNotNull(someRestController);
46 | assertEquals("SomeApiController", someRestController.getName());
47 | assertEquals("com.structurizr.analysis.myapp.api.SomeApiController", someRestController.getType().getType());
48 | assertEquals(1, someRestController.getCode().size());
49 |
50 | Component someService = webApplication.getComponentWithName("SomeService");
51 | assertNotNull(someService);
52 | assertEquals("SomeService", someService.getName());
53 | assertEquals("com.structurizr.analysis.myapp.service.SomeService", someService.getType().getType());
54 | assertEquals(2, someService.getCode().size());
55 | assertCodeElementInComponent(someService, "com.structurizr.analysis.myapp.service.SomeService", CodeElementRole.Primary);
56 | assertCodeElementInComponent(someService, "com.structurizr.analysis.myapp.service.SomeServiceImpl", CodeElementRole.Supporting);
57 |
58 | Component someRepository = webApplication.getComponentWithName("SomeRepository");
59 | assertNotNull(someRepository);
60 | assertEquals("SomeRepository", someRepository.getName());
61 | assertEquals("com.structurizr.analysis.myapp.data.SomeRepository", someRepository.getType().getType());
62 | assertEquals(2, someRepository.getCode().size());
63 | assertCodeElementInComponent(someRepository, "com.structurizr.analysis.myapp.data.SomeRepository", CodeElementRole.Primary);
64 | assertCodeElementInComponent(someRepository, "com.structurizr.analysis.myapp.data.JdbcSomeRepository", CodeElementRole.Supporting);
65 |
66 |
67 | Component someOtherRepository = webApplication.getComponentWithName("SomeOtherRepository");
68 | assertNotNull(someOtherRepository);
69 | assertEquals("SomeOtherRepository", someOtherRepository.getName());
70 | assertEquals("com.structurizr.analysis.myapp.data.SomeOtherRepository", someOtherRepository.getType().getType());
71 |
72 | assertEquals(1, someMvcController.getRelationships().size());
73 | Relationship relationship = someMvcController.getRelationships().iterator().next();
74 | assertEquals(someMvcController, relationship.getSource());
75 | assertEquals(someService, relationship.getDestination());
76 |
77 | assertEquals(1, someRestController.getRelationships().size());
78 | relationship = someRestController.getRelationships().iterator().next();
79 | assertEquals(someRestController, relationship.getSource());
80 | assertEquals(someService, relationship.getDestination());
81 |
82 | assertEquals(2, someService.getRelationships().size());
83 |
84 | Set relationships = someService.getRelationships();
85 | assertNotNull(relationships.stream().filter(r -> r.getDestination() == someRepository).findFirst().get());
86 | assertNotNull(relationships.stream().filter(r -> r.getDestination() == someOtherRepository).findFirst().get());
87 | }
88 |
89 | private void assertCodeElementInComponent(Component component, String type, CodeElementRole role) {
90 | for (CodeElement codeElement : component.getCode()) {
91 | if (codeElement.getType().equals(type) && codeElement.getRole() == role) {
92 | return;
93 | }
94 | }
95 |
96 | fail("Component " + component.getName() + " does not have a " + role + " code element of type " + type);
97 | }
98 |
99 | @Test
100 | public void test_findComponents_UsesTheConfiguredDuplicateComponentFinderStrategy() throws Exception {
101 | try {
102 | SpringComponentFinderStrategy springComponentFinderStrategy = new SpringComponentFinderStrategy();
103 | springComponentFinderStrategy.setDuplicateComponentStrategy(new DuplicateComponentStrategy() {
104 | @Override
105 | public Component duplicateComponentFound(Component component, String name, String type, String description, String technology) {
106 | return null;
107 | }
108 | });
109 |
110 | ComponentFinder componentFinder = new ComponentFinder(
111 | webApplication,
112 | "com.structurizr.analysis.myapp",
113 | springComponentFinderStrategy
114 | );
115 |
116 | componentFinder.findComponents();
117 | componentFinder.findComponents();
118 | } catch (DuplicateComponentException dce) {
119 | fail();
120 | }
121 | }
122 |
123 | }
124 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/SpringMvcControllerComponentFinderStrategyTests.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis;
2 |
3 | import com.structurizr.Workspace;
4 | import com.structurizr.model.Component;
5 | import com.structurizr.model.Container;
6 | import com.structurizr.model.Model;
7 | import com.structurizr.model.SoftwareSystem;
8 | import org.junit.Test;
9 |
10 | import static org.junit.Assert.assertEquals;
11 |
12 | public class SpringMvcControllerComponentFinderStrategyTests {
13 |
14 | @Test
15 | public void test_findComponents_FindsSpringMvcControllers() throws Exception {
16 | Workspace workspace = new Workspace("Name", "Description");
17 | Model model = workspace.getModel();
18 | SoftwareSystem softwareSystem = model.addSoftwareSystem("Name", "Description");
19 | Container container = softwareSystem.addContainer("Name", "Description", "Technology");
20 |
21 | ComponentFinder componentFinder = new ComponentFinder(
22 | container,
23 | "test.SpringMvcControllerComponentFinderStrategy",
24 | new SpringMvcControllerComponentFinderStrategy()
25 | );
26 | componentFinder.findComponents();
27 |
28 | assertEquals(1, container.getComponents().size());
29 | Component component = container.getComponentWithName("SomeController");
30 | assertEquals("test.SpringMvcControllerComponentFinderStrategy.SomeController", component.getType().getType());
31 | assertEquals("", component.getDescription());
32 | assertEquals("Spring MVC Controller", component.getTechnology());
33 | }
34 |
35 | }
36 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/SpringRepositoryComponentFinderStrategyTests.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis;
2 |
3 | import com.structurizr.Workspace;
4 | import com.structurizr.model.Component;
5 | import com.structurizr.model.Container;
6 | import com.structurizr.model.Model;
7 | import com.structurizr.model.SoftwareSystem;
8 | import org.junit.Test;
9 |
10 | import static org.junit.Assert.assertEquals;
11 |
12 | public class SpringRepositoryComponentFinderStrategyTests {
13 |
14 | @Test
15 | public void test_findComponents_FindsSpringRepositoriesDefinedWithAnAnnotation() throws Exception {
16 | Workspace workspace = new Workspace("Name", "Description");
17 | Model model = workspace.getModel();
18 | SoftwareSystem softwareSystem = model.addSoftwareSystem("Name", "Description");
19 | Container container = softwareSystem.addContainer("Name", "Description", "Technology");
20 |
21 | ComponentFinder componentFinder = new ComponentFinder(
22 | container,
23 | "test.SpringRepositoryComponentFinderStrategy.annotation",
24 | new SpringRepositoryComponentFinderStrategy()
25 | );
26 | componentFinder.findComponents();
27 |
28 | // finding the components again should be idempotent
29 | componentFinder.findComponents();
30 |
31 | assertEquals(1, container.getComponents().size());
32 | Component component = container.getComponentWithName("SomeRepository");
33 | assertEquals("test.SpringRepositoryComponentFinderStrategy.annotation.SomeRepository", component.getType().getType());
34 | assertEquals("", component.getDescription());
35 | assertEquals("Spring Repository", component.getTechnology());
36 | }
37 |
38 | @Test
39 | public void test_findComponents_FindsSpringRepositoriesThatExtendJpaRepository() throws Exception {
40 | Workspace workspace = new Workspace("Name", "Description");
41 | Model model = workspace.getModel();
42 | SoftwareSystem softwareSystem = model.addSoftwareSystem("Name", "Description");
43 | Container container = softwareSystem.addContainer("Name", "Description", "Technology");
44 |
45 | ComponentFinder componentFinder = new ComponentFinder(
46 | container,
47 | "test.SpringRepositoryComponentFinderStrategy.jpaRepository",
48 | new SpringRepositoryComponentFinderStrategy()
49 | );
50 | componentFinder.findComponents();
51 |
52 | assertEquals(1, container.getComponents().size());
53 | Component component = container.getComponentWithName("SomeJpaRepository");
54 | assertEquals("test.SpringRepositoryComponentFinderStrategy.jpaRepository.SomeJpaRepository", component.getType().getType());
55 | assertEquals("", component.getDescription());
56 | assertEquals("Spring Repository", component.getTechnology());
57 | }
58 |
59 | @Test
60 | public void test_findComponents_FindsSpringRepositoriesThatExtendCrudRepository() throws Exception {
61 | Workspace workspace = new Workspace("Name", "Description");
62 | Model model = workspace.getModel();
63 | SoftwareSystem softwareSystem = model.addSoftwareSystem("Name", "Description");
64 | Container container = softwareSystem.addContainer("Name", "Description", "Technology");
65 |
66 | ComponentFinder componentFinder = new ComponentFinder(
67 | container,
68 | "test.SpringRepositoryComponentFinderStrategy.crudRepository",
69 | new SpringRepositoryComponentFinderStrategy()
70 | );
71 | componentFinder.findComponents();
72 |
73 | assertEquals(1, container.getComponents().size());
74 | Component component = container.getComponentWithName("SomeCrudRepository");
75 | assertEquals("test.SpringRepositoryComponentFinderStrategy.crudRepository.SomeCrudRepository", component.getType().getType());
76 | assertEquals("", component.getDescription());
77 | assertEquals("Spring Repository", component.getTechnology());
78 | }
79 |
80 | }
81 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/SpringRestControllerComponentFinderStrategyTests.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis;
2 |
3 | import com.structurizr.Workspace;
4 | import com.structurizr.model.Component;
5 | import com.structurizr.model.Container;
6 | import com.structurizr.model.Model;
7 | import com.structurizr.model.SoftwareSystem;
8 | import org.junit.Test;
9 |
10 | import static org.junit.Assert.assertEquals;
11 |
12 | public class SpringRestControllerComponentFinderStrategyTests {
13 |
14 | @Test
15 | public void test_findComponents_FindsSpringRestControllers() throws Exception {
16 | Workspace workspace = new Workspace("Name", "Description");
17 | Model model = workspace.getModel();
18 | SoftwareSystem softwareSystem = model.addSoftwareSystem("Name", "Description");
19 | Container container = softwareSystem.addContainer("Name", "Description", "Technology");
20 |
21 | ComponentFinder componentFinder = new ComponentFinder(
22 | container,
23 | "test.SpringRestControllerComponentFinderStrategy",
24 | new SpringRestControllerComponentFinderStrategy()
25 | );
26 | componentFinder.findComponents();
27 |
28 | assertEquals(1, container.getComponents().size());
29 | Component component = container.getComponentWithName("SomeController");
30 | assertEquals("test.SpringRestControllerComponentFinderStrategy.SomeController", component.getType().getType());
31 | assertEquals("", component.getDescription());
32 | assertEquals("Spring REST Controller", component.getTechnology());
33 | }
34 |
35 | }
36 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/SpringServiceComponentFinderStrategyTests.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis;
2 |
3 | import com.structurizr.Workspace;
4 | import com.structurizr.model.Component;
5 | import com.structurizr.model.Container;
6 | import com.structurizr.model.Model;
7 | import com.structurizr.model.SoftwareSystem;
8 | import org.junit.Test;
9 |
10 | import static org.junit.Assert.assertEquals;
11 |
12 | public class SpringServiceComponentFinderStrategyTests {
13 |
14 | @Test
15 | public void test_findComponents_FindsSpringServices() throws Exception {
16 | Workspace workspace = new Workspace("Name", "Description");
17 | Model model = workspace.getModel();
18 | SoftwareSystem softwareSystem = model.addSoftwareSystem("Name", "Description");
19 | Container container = softwareSystem.addContainer("Name", "Description", "Technology");
20 |
21 | ComponentFinder componentFinder = new ComponentFinder(
22 | container,
23 | "test.SpringServiceComponentFinderStrategy",
24 | new SpringServiceComponentFinderStrategy()
25 | );
26 | componentFinder.findComponents();
27 |
28 | assertEquals(1, container.getComponents().size());
29 | Component component = container.getComponentWithName("SomeService");
30 | assertEquals("test.SpringServiceComponentFinderStrategy.SomeService", component.getType().getType());
31 | assertEquals("", component.getDescription());
32 | assertEquals("Spring Service", component.getTechnology());
33 | }
34 |
35 | }
36 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/SpringWebServiceEndpointComponentFinderStrategyTests.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis;
2 |
3 | import com.structurizr.Workspace;
4 | import com.structurizr.model.Component;
5 | import com.structurizr.model.Container;
6 | import com.structurizr.model.Model;
7 | import com.structurizr.model.SoftwareSystem;
8 | import org.junit.Test;
9 |
10 | import static org.junit.Assert.assertEquals;
11 |
12 | public class SpringWebServiceEndpointComponentFinderStrategyTests {
13 |
14 | @Test
15 | public void test_findComponents_FindsSpringWebServiceEndpoints() throws Exception {
16 | Workspace workspace = new Workspace("Name", "Description");
17 | Model model = workspace.getModel();
18 | SoftwareSystem softwareSystem = model.addSoftwareSystem("Name", "Description");
19 | Container container = softwareSystem.addContainer("Name", "Description", "Technology");
20 |
21 | ComponentFinder componentFinder = new ComponentFinder(
22 | container,
23 | "test.SpringWebServiceEndpointComponentFinderStrategy",
24 | new SpringWebServiceEndpointComponentFinderStrategy()
25 | );
26 | componentFinder.findComponents();
27 |
28 | assertEquals(1, container.getComponents().size());
29 | Component component = container.getComponentWithName("SomeWebService");
30 | assertEquals("test.SpringWebServiceEndpointComponentFinderStrategy.SomeWebService", component.getType().getType());
31 | assertEquals("", component.getDescription());
32 | assertEquals("Spring Web Service", component.getTechnology());
33 | }
34 |
35 | }
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/myapp/api/SomeApiController.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis.myapp.api;
2 |
3 | import com.structurizr.analysis.myapp.service.SomeService;
4 | import org.springframework.beans.factory.annotation.Autowired;
5 | import org.springframework.web.bind.annotation.RestController;
6 |
7 | @RestController
8 | public class SomeApiController {
9 |
10 | @Autowired
11 | private SomeService someService;
12 |
13 | //@RequestMapping(value = "/do/something") - commenting this out removes a dependency on Spring MVC
14 | public String findSomething() {
15 | someService.doSomething();
16 |
17 | return "{some json}";
18 | }
19 |
20 | }
21 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/myapp/data/JdbcSomeRepository.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis.myapp.data;
2 |
3 | import com.structurizr.analysis.myapp.domain.Something;
4 | import org.springframework.stereotype.Repository;
5 |
6 | @Repository
7 | public class JdbcSomeRepository implements SomeRepository {
8 |
9 | @Override
10 | public Something findSomething() {
11 | return new Something();
12 | }
13 |
14 | }
15 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/myapp/data/SomeNonPublicRepository.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis.myapp.data;
2 |
3 | import org.springframework.data.jpa.repository.JpaRepository;
4 |
5 | interface SomeNonPublicRepository extends JpaRepository {
6 | }
7 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/myapp/data/SomeOtherRepository.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis.myapp.data;
2 |
3 | import org.springframework.data.jpa.repository.JpaRepository;
4 |
5 | public interface SomeOtherRepository extends JpaRepository {
6 | }
7 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/myapp/data/SomeRepository.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis.myapp.data;
2 |
3 | import com.structurizr.analysis.myapp.domain.Something;
4 |
5 | public interface SomeRepository {
6 |
7 | Something findSomething();
8 |
9 | }
10 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/myapp/domain/Something.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis.myapp.domain;
2 |
3 | /**
4 | * Created by structurizr on 15/03/16.
5 | */
6 | public class Something {
7 | }
8 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/myapp/service/SomeService.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis.myapp.service;
2 |
3 | public interface SomeService {
4 |
5 | void doSomething();
6 |
7 | }
8 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/myapp/service/SomeServiceImpl.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis.myapp.service;
2 |
3 | import com.structurizr.analysis.myapp.data.SomeOtherRepository;
4 | import com.structurizr.analysis.myapp.data.SomeRepository;
5 | import org.springframework.beans.factory.annotation.Autowired;
6 | import org.springframework.stereotype.Service;
7 |
8 | @Service
9 | public class SomeServiceImpl implements SomeService {
10 |
11 | @Autowired
12 | private SomeRepository someRepository;
13 |
14 | @Autowired
15 | private SomeOtherRepository someOtherRepository;
16 |
17 | public void doSomething() {
18 | someRepository.findSomething();
19 | }
20 |
21 | }
22 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/com/structurizr/analysis/myapp/web/SomeController.java:
--------------------------------------------------------------------------------
1 | package com.structurizr.analysis.myapp.web;
2 |
3 | import com.structurizr.analysis.myapp.service.SomeService;
4 | import org.springframework.beans.factory.annotation.Autowired;
5 | import org.springframework.stereotype.Controller;
6 |
7 | @Controller
8 | public class SomeController {
9 |
10 | @Autowired
11 | private SomeService someService;
12 |
13 | //@RequestMapping(value = "/do/something") - commenting this out removes a dependency on Spring MVC
14 | public String showHomePage() {
15 | someService.doSomething();
16 |
17 | return "/did/something";
18 | }
19 |
20 | }
21 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/test/AbstractSpringComponentFinderStrategy/SomeController.java:
--------------------------------------------------------------------------------
1 | package test.AbstractSpringComponentFinderStrategy;
2 |
3 | import org.springframework.stereotype.Controller;
4 |
5 | @Controller
6 | public class SomeController {
7 | }
8 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/test/AbstractSpringComponentFinderStrategy/SomeNonPublicRepository.java:
--------------------------------------------------------------------------------
1 | package test.AbstractSpringComponentFinderStrategy;
2 |
3 | import org.springframework.data.jpa.repository.JpaRepository;
4 |
5 | interface SomeNonPublicRepository extends JpaRepository {
6 | }
7 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/test/AbstractSpringComponentFinderStrategy/SomePublicRepository.java:
--------------------------------------------------------------------------------
1 | package test.AbstractSpringComponentFinderStrategy;
2 |
3 | import org.springframework.data.jpa.repository.JpaRepository;
4 |
5 | public interface SomePublicRepository extends JpaRepository {
6 | }
7 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/test/SpringComponentComponentFinderStrategy/SomeComponent.java:
--------------------------------------------------------------------------------
1 | package test.SpringComponentComponentFinderStrategy;
2 |
3 | public interface SomeComponent {
4 | }
5 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/test/SpringComponentComponentFinderStrategy/TheSomeComponentImpl.java:
--------------------------------------------------------------------------------
1 | package test.SpringComponentComponentFinderStrategy;
2 |
3 | import org.springframework.stereotype.Component;
4 |
5 | @Component
6 | public class TheSomeComponentImpl implements SomeComponent {
7 | }
8 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/test/SpringMvcControllerComponentFinderStrategy/SomeController.java:
--------------------------------------------------------------------------------
1 | package test.SpringMvcControllerComponentFinderStrategy;
2 |
3 | import org.springframework.stereotype.Controller;
4 |
5 | @Controller
6 | public class SomeController {
7 | }
8 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/test/SpringRepositoryComponentFinderStrategy/annotation/JdbcSomeRepository.java:
--------------------------------------------------------------------------------
1 | package test.SpringRepositoryComponentFinderStrategy.annotation;
2 |
3 | public class JdbcSomeRepository implements SomeRepository {
4 | }
5 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/test/SpringRepositoryComponentFinderStrategy/annotation/SomeRepository.java:
--------------------------------------------------------------------------------
1 | package test.SpringRepositoryComponentFinderStrategy.annotation;
2 |
3 | import org.springframework.stereotype.Repository;
4 |
5 | @Repository
6 | public interface SomeRepository {
7 | }
8 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/test/SpringRepositoryComponentFinderStrategy/crudRepository/SomeCrudRepository.java:
--------------------------------------------------------------------------------
1 | package test.SpringRepositoryComponentFinderStrategy.crudRepository;
2 |
3 | import org.springframework.data.repository.CrudRepository;
4 |
5 | public interface SomeCrudRepository extends CrudRepository {
6 | }
7 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/test/SpringRepositoryComponentFinderStrategy/jpaRepository/SomeJpaRepository.java:
--------------------------------------------------------------------------------
1 | package test.SpringRepositoryComponentFinderStrategy.jpaRepository;
2 |
3 | import org.springframework.data.jpa.repository.JpaRepository;
4 |
5 | public interface SomeJpaRepository extends JpaRepository {
6 | }
7 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/test/SpringRestControllerComponentFinderStrategy/SomeController.java:
--------------------------------------------------------------------------------
1 | package test.SpringRestControllerComponentFinderStrategy;
2 |
3 | import org.springframework.web.bind.annotation.RestController;
4 |
5 | @RestController
6 | public class SomeController {
7 | }
8 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/test/SpringServiceComponentFinderStrategy/SomeService.java:
--------------------------------------------------------------------------------
1 | package test.SpringServiceComponentFinderStrategy;
2 |
3 | public interface SomeService {
4 | }
5 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/test/SpringServiceComponentFinderStrategy/SomeServiceImpl.java:
--------------------------------------------------------------------------------
1 | package test.SpringServiceComponentFinderStrategy;
2 |
3 | import org.springframework.stereotype.Service;
4 |
5 | @Service
6 | public class SomeServiceImpl implements SomeService {
7 | }
8 |
--------------------------------------------------------------------------------
/structurizr-spring/test/unit/test/SpringWebServiceEndpointComponentFinderStrategy/SomeWebService.java:
--------------------------------------------------------------------------------
1 | package test.SpringWebServiceEndpointComponentFinderStrategy;
2 |
3 | import org.springframework.ws.server.endpoint.annotation.Endpoint;
4 |
5 | @Endpoint
6 | public class SomeWebService {
7 | }
--------------------------------------------------------------------------------