Tweet
Tweet

Slide 1

Slide 1 text

Beyond JUnit: Devnexus 2022 2022-04-14 Todd Ginsberg Platform Architect Pragmatic Ways to Increase Code Quality @ToddGinsberg

Slide 2

Slide 2 text

@ToddGinsberg Beyond JUnit: Pragmatic Ways to Increase Code Quality

Slide 3

Slide 3 text

@ToddGinsberg Beyond JUnit: Pragmatic Ways to Increase Code Quality

Slide 4

Slide 4 text

@ToddGinsberg Beyond JUnit: Pragmatic Ways to Increase Code Quality “Dealing with things sensibly and realistically in a way that is based on practical rather than theoretical considerations.” (Thanks, Google!)

Slide 5

Slide 5 text

@ToddGinsberg I Am Making Some Assumptions About You…

Slide 6

Slide 6 text

@ToddGinsberg I Am Making Some Assumptions About You… ● You already write some kind of tests using a modern framework like JUnit 5.

Slide 7

Slide 7 text

@ToddGinsberg I Am Making Some Assumptions About You… ● You already write some kind of tests using a modern framework like JUnit 5. ● You have covered the basics of code quality with static analysis tools, and maybe an enforced coding style.

Slide 8

Slide 8 text

@ToddGinsberg What You Will See In This Talk

Slide 9

Slide 9 text

@ToddGinsberg What You Will See In This Talk 1) How to test the architecture of your code.

Slide 10

Slide 10 text

@ToddGinsberg What You Will See In This Talk 1) How to test the architecture of your code. 2) How to test that your code plays well with others.

Slide 11

Slide 11 text

Two Things To Keep In Mind

Slide 12

Slide 12 text

@ToddGinsberg Any fool can write code that a computer can understand. Good programmers write code that humans can understand. – Martin Fowler Refactoring: Improving the Design of Existing Code

Slide 13

Slide 13 text

@ToddGinsberg Any fool can write code that a computer can understand. Good programmers write code that humans can understand. – Martin Fowler Refactoring: Improving the Design of Existing Code

Slide 14

Slide 14 text

@ToddGinsberg Testing shows the presence, not the absence of bugs. – Edsger W. Dijkstra October, 1969

Slide 15

Slide 15 text

Architectural Testing

Slide 16

Slide 16 text

@ToddGinsberg What’s the Problem?

Slide 17

Slide 17 text

@ToddGinsberg What’s the Problem? Photo by Dawid Zawiła on Unsplash

Slide 18

Slide 18 text

@ToddGinsberg What’s the Problem? API Layer

Slide 19

Slide 19 text

@ToddGinsberg What’s the Problem? API Layer Service Layer

Slide 20

Slide 20 text

@ToddGinsberg What’s the Problem? API Layer Service Layer Data Layer

Slide 21

Slide 21 text

@ToddGinsberg What’s the Problem? API Layer Service Layer Data Layer

Slide 22

Slide 22 text

@ToddGinsberg What’s the Problem? API Layer Service Layer Data Layer

Slide 23

Slide 23 text

@ToddGinsberg What’s the Problem? API Layer Service Layer Data Layer Controller Service Controller Service Repository Repository

Slide 24

Slide 24 text

@ToddGinsberg What’s the Problem? API Layer Service Layer Data Layer Controller Service Controller Service Repository Repository

Slide 25

Slide 25 text

@ToddGinsberg What’s the Problem? API Layer Service Layer Data Layer Controller Service Controller Service Repository Repository

Slide 26

Slide 26 text

@ToddGinsberg What’s the Problem? API Layer Service Layer Data Layer Controller Service Controller Service Repository Repository

Slide 27

Slide 27 text

@ToddGinsberg How Do We Enforce Architectural Rules?

Slide 28

Slide 28 text

@ToddGinsberg How Do We Enforce Architectural Rules? BIGCORP_Architecture_Rules_2003(1)_FINAL_UPDATE-3a.doc

Slide 29

Slide 29 text

@ToddGinsberg How Do We Enforce Architectural Rules?

Slide 30

Slide 30 text

@ToddGinsberg How Do We Enforce Architectural Rules? 10 YEARS AGO!

Slide 31

Slide 31 text

@ToddGinsberg How Do We Enforce Architectural Rules? LEFT NINE YEARS AGO!

Slide 32

Slide 32 text

@ToddGinsberg How Do We Enforce Architectural Rules?

Slide 33

Slide 33 text

@ToddGinsberg How Do We Enforce Architectural Rules?

Slide 34

Slide 34 text

@ToddGinsberg What We Want

Slide 35

Slide 35 text

@ToddGinsberg What We Want Automatic

Slide 36

Slide 36 text

@ToddGinsberg What We Want Automatic Accessable

Slide 37

Slide 37 text

@ToddGinsberg What We Want Automatic Accessable Fast

Slide 38

Slide 38 text

@ToddGinsberg ArchUnit To The Rescue! https://archunit.org

Slide 39

Slide 39 text

@ToddGinsberg Adding To Our Project testImplementation( 'com.tngtech.archunit:archunit-junit5:0.23.1' )

Slide 40

Slide 40 text

@ToddGinsberg Adding To Our Project testImplementation( 'com.tngtech.archunit:archunit-junit5:0.23.1' ) com.tngtech.archunit archunit-junit5 0.23.1 test

Slide 41

Slide 41 text

@ToddGinsberg Our First Architectural Test… SomeServiceImpl

Slide 42

Slide 42 text

@ToddGinsberg Our First Architectural Test… SomeServiceImpl

Slide 43

Slide 43 text

@ToddGinsberg Our First Architectural Test… @Test public void implNamingRule() { }

Slide 44

Slide 44 text

@ToddGinsberg Our First Architectural Test… @Test public void implNamingRule() { JavaClasses classes = // TODO }

Slide 45

Slide 45 text

@ToddGinsberg Our First Architectural Test… @Test public void implNamingRule() { JavaClasses classes = // TODO ArchRule theRule = // TODO }

Slide 46

Slide 46 text

@ToddGinsberg Our First Architectural Test… @Test public void implNamingRule() { JavaClasses classes = // TODO ArchRule theRule = // TODO theRule.check(classes); }

Slide 47

Slide 47 text

@ToddGinsberg Our First Architectural Test… @Test public void implNamingRule() { JavaClasses classes = new ClassFileImporter() .importPackages( "com.example.donutapi" ); }

Slide 48

Slide 48 text

@ToddGinsberg Our First Architectural Test… @Test public void implNamingRule() { JavaClasses classes = new ClassFileImporter() .importPackages( "com.example.donutapi", "com.example.utilities" ); }

Slide 49

Slide 49 text

@ToddGinsberg Our First Architectural Test… @Test public void implNamingRule() { JavaClasses classes = new ClassFileImporter() .importPackages("com.example.donutapi"); ArchRule theRule = theRule.check(classes); }

Slide 50

Slide 50 text

@ToddGinsberg Our First Architectural Test… @Test public void implNamingRule() { JavaClasses classes = new ClassFileImporter() .importPackages("com.example.donutapi"); ArchRule theRule = noClasses() theRule.check(classes); }

Slide 51

Slide 51 text

@ToddGinsberg Our First Architectural Test… @Test public void implNamingRule() { JavaClasses classes = new ClassFileImporter() .importPackages("com.example.donutapi"); ArchRule theRule = noClasses() .should() theRule.check(classes); }

Slide 52

Slide 52 text

@ToddGinsberg Our First Architectural Test… @Test public void implNamingRule() { JavaClasses classes = new ClassFileImporter() .importPackages("com.example.donutapi"); ArchRule theRule = noClasses() .should() .haveNameMatching(".*Impl"); theRule.check(classes); }

Slide 53

Slide 53 text

@ToddGinsberg Our First Architectural Test… ArchRule theRule = noClasses() .should() .haveNameMatching(".*Impl");

Slide 54

Slide 54 text

@ToddGinsberg Our First Architectural Test… ArchRule theRule = noClasses() .should() .haveNameMatching(".*Impl"); Architecture Violation [Priority: MEDIUM] - Rule 'no classes should have name matching '.*Impl'' was violated (1 times): Class matches '.*Impl' in (SomeServiceImpl.java:0)

Slide 55

Slide 55 text

@ToddGinsberg Our First Architectural Test… ArchRule theRule = noClasses() .should() .haveNameMatching(".*Impl"); Architecture Violation [Priority: MEDIUM] - Rule 'no classes should have name matching '.*Impl'' was violated (1 times): Class matches '.*Impl' in (SomeServiceImpl.java:0)

Slide 56

Slide 56 text

@ToddGinsberg Our First Architectural Test… ArchRule theRule = noClasses() .should() .haveNameMatching(".*Impl"); Architecture Violation [Priority: MEDIUM] - Rule 'no classes should have name matching '.*Impl'' was violated (1 times): Class matches '.*Impl' in (SomeServiceImpl.java:0)

Slide 57

Slide 57 text

@ToddGinsberg Our First Architectural Test… ArchRule theRule = noClasses() .should() .haveNameMatching(".*Impl"); Architecture Violation [Priority: MEDIUM] - Rule 'no classes should have name matching '.*Impl'' was violated (1 times): Class matches '.*Impl' in (SomeServiceImpl.java:0)

Slide 58

Slide 58 text

@ToddGinsberg Our First Architectural Test… ArchRule theRule = noClasses() .should() .haveNameMatching(".*Impl");

Slide 59

Slide 59 text

@ToddGinsberg Our First Architectural Test… ArchRule theRule = noClasses() .should() .haveNameMatching(".*Impl") .because("it doesn't tell us anything useful");

Slide 60

Slide 60 text

@ToddGinsberg Our First Architectural Test… ArchRule theRule = noClasses() .should() .haveNameMatching(".*Impl") .because("it doesn't tell us anything useful"); Architecture Violation [Priority: MEDIUM] - Rule 'no classes should have name matching '.*Impl', because it doesn't tell us anything useful' was violated (1 times): Class matches '.*Impl' in (SomeServiceImpl.java:0)

Slide 61

Slide 61 text

@ToddGinsberg Our First Architectural Test (Simplified) @AnalyzeClasses( packages = {"com.example.donutapi"}, importOptions = {ImportOption.DoNotIncludeTests.class} ) public class ExampleTest { @ArchTest static final ArchRule implNaming = noClasses() .should() .haveNameMatching(".*Impl") .because("it doesn't tell us anything useful"); }

Slide 62

Slide 62 text

@ToddGinsberg Our First Architectural Test (Simplified) @AnalyzeClasses( packages = {"com.example.donutapi"}, importOptions = {ImportOption.DoNotIncludeTests.class} ) public class ExampleTest { @ArchTest static final ArchRule implNaming = noClasses() .should() .haveNameMatching(".*Impl") .because("it doesn't tell us anything useful"); }

Slide 63

Slide 63 text

@ToddGinsberg Our First Architectural Test (Simplified) @AnalyzeClasses( packages = {"com.example.donutapi"}, importOptions = {ImportOption.DoNotIncludeTests.class} ) public class ExampleTest { @ArchTest static final ArchRule implNaming = noClasses() .should() .haveNameMatching(".*Impl") .because("it doesn't tell us anything useful"); }

Slide 64

Slide 64 text

@ToddGinsberg Our First Architectural Test (Simplified) @AnalyzeClasses( packages = {"com.example.donutapi"}, importOptions = {ImportOption.DoNotIncludeTests.class} ) public class ExampleTest { @ArchTest static final ArchRule implNaming = noClasses() .should() .haveNameMatching(".*Impl") .because("it doesn't tell us anything useful"); }

Slide 65

Slide 65 text

@ToddGinsberg Our First Architectural Test (Simplified) @AnalyzeClasses( packages = {"com.example.donutapi"}, importOptions = {ImportOption.DoNotIncludeTests.class} ) public class ExampleTest { @ArchTest static final ArchRule implNaming = noClasses() .should() .haveNameMatching(".*Impl") .because("it doesn't tell us anything useful"); }

Slide 66

Slide 66 text

@ToddGinsberg Our First Architectural Test (Simplified) @AnalyzeClasses( packages = {"com.example.donutapi"}, importOptions = {ImportOption.DoNotIncludeTests.class} ) public class ExampleTest { @ArchTest static final ArchRule implNaming = noClasses() .should() .haveNameMatching(".*Impl") .because("it doesn't tell us anything useful"); }

Slide 67

Slide 67 text

@ToddGinsberg Our First Architectural Test (Simplified) @ArchTest static final ArchRule implNaming = noClasses() .should() .haveNameMatching(".*Impl") .because("it doesn't tell us anything useful");

Slide 68

Slide 68 text

@ToddGinsberg Our First Architectural Test (Simplified) noClasses() .should() .haveNameMatching(".*Impl") .because("it doesn't tell us anything useful");

Slide 69

Slide 69 text

@ToddGinsberg Use Case: Prohibit Dependencies noClasses() .should()

Slide 70

Slide 70 text

@ToddGinsberg Use Case: Prohibit Dependencies noClasses() .should() .dependOnClassesThat()

Slide 71

Slide 71 text

@ToddGinsberg Use Case: Prohibit Dependencies noClasses() .should() .dependOnClassesThat() .resideInAnyPackage( "org.apache.log4j", "org.apache.logging.log4j" )

Slide 72

Slide 72 text

@ToddGinsberg Use Case: Prohibit Dependencies noClasses() .should() .dependOnClassesThat() .resideInAnyPackage( "org.apache.log4j", "org.apache.logging.log4j" ) .because("our standard is logback");

Slide 73

Slide 73 text

@ToddGinsberg Use Case: Prohibit Dependencies Architecture Violation [Priority: MEDIUM] - Rule 'no classes should depend on classes that reside in any package ['org.apache.log4j', 'org.apache.logging.log4j'], because our standard is logback' was violated (2 times):

Slide 74

Slide 74 text

@ToddGinsberg Simplify Violation Messages Architecture Violation [Priority: MEDIUM] - Rule 'no classes should depend on classes that reside in any package ['org.apache.log4j', 'org.apache.logging.log4j'], because our standard is logback' was violated (2 times):

Slide 75

Slide 75 text

@ToddGinsberg Simplify Violation Messages noClasses() .should() .dependOnClassesThat() .resideInAnyPackage( "org.apache.log4j", "org.apache.logging.log4j" ) .because("our standard is logback");

Slide 76

Slide 76 text

@ToddGinsberg Simplify Violation Messages noClasses() .should() .dependOnClassesThat() .resideInAnyPackage( "org.apache.log4j", "org.apache.logging.log4j" ) .as("stop using log4j") .because("our standard is logback");

Slide 77

Slide 77 text

@ToddGinsberg Simplify Violation Messages Architecture Violation [Priority: MEDIUM] - Rule 'stop using log4j, because our standard is logback' was violated (2 times):

Slide 78

Slide 78 text

@ToddGinsberg Simplify Violation Messages Architecture Violation [Priority: MEDIUM] - Rule 'stop using log4j, because our standard is logback' was violated (2 times):

Slide 79

Slide 79 text

@ToddGinsberg Parts of a Rule classes() .that() .areAnnotatedWith(Controller.class) .or().areAnnotatedWith(RestController.class) .should() .resideInAPackage("..controller..") .because("controllers belong in a controller package");

Slide 80

Slide 80 text

@ToddGinsberg Parts of a Rule classes() .that() .areAnnotatedWith(Controller.class) .or().areAnnotatedWith(RestController.class) .should() .resideInAPackage("..controller..") .because("controllers belong in a controller package");

Slide 81

Slide 81 text

@ToddGinsberg Parts of a Rule classes() .that() .areAnnotatedWith(Controller.class) .or().areAnnotatedWith(RestController.class) .should() .resideInAPackage("..controller..") .because("controllers belong in a controller package");

Slide 82

Slide 82 text

@ToddGinsberg Class Predicates areAnnotatedWith areAnnotations areAnonymousClasses areAssignableFrom areAssignableTo areEnums areInnerClasses areInterfaces areLocalClasses areMemberClasses areMetaAnnotatedWith areNestedClasses areNotAnnotatedWith areNotAnnotations areNotAnonymousClasses areNotAssignableFrom areNotAssignableTo areNotEnums areNotInnerClasses areNotInterfaces areNotLocalClasses areNotMemberClasses areNotMetaAnnotatedWith areNotNestedClasses areNotPackagePrivate areNotPrivate areNotProtected areNotPublic areNotRecords areNotTopLevelClasses arePackagePrivate arePrivate

Slide 83

Slide 83 text

@ToddGinsberg Class Predicates areProtected arePublic areRecords areTopLevelClasses belongToAnyOf containAnyCodeUnitsThat containAnyConstructorsThat containAnyFieldsThat containAnyMembersThat containAnyMethodsThat containAnyStaticInitializersThat doNotBelongToAnyOf doNotHaveFullyQualifiedName doNotHaveModifier doNotHaveSimpleName doNotImplement haveFullyQualifiedName haveModifier haveNameMatching haveNameNotMatching haveSimpleName haveSimpleNameContaining haveSimpleNameEndingWith haveSimpleNameNotContaining haveSimpleNameNotEndingWith haveSimpleNameNotStartingWith haveSimpleNameStartingWith implement resideInAPackage resideInAnyPackage resideOutsideOfPackage resideOutsideOfPackages

Slide 84

Slide 84 text

@ToddGinsberg Parts of a Rule classes() .that() .areAnnotatedWith(Controller.class) .or().areAnnotatedWith(RestController.class) .should() .resideInAPackage("..controller..") .because("controllers belong in a controller package");

Slide 85

Slide 85 text

@ToddGinsberg Class Conditions accessClassesThat accessField accessFieldWhere accessTargetWhere be beAnnotatedWith beAnonymousClasses beAssignableFrom beAssignableTo beEnums beInnerClasses beInterfaces beLocalClasses beMemberClasses beMetaAnnotatedWith beNestedClasses bePackagePrivate bePrivate beProtected bePublic beRecords beTopLevelClasses callCodeUnitWhere callConstructor callConstructorWhere callMethod callMethodWhere containNumberOfElements dependOnClassesThat getField getFieldWhere haveFullyQualifiedName

Slide 86

Slide 86 text

@ToddGinsberg Class Conditions haveModifier haveNameMatching haveNameNotMatching haveOnlyFinalFields haveOnlyPrivateConstructors haveSimpleName haveSimpleNameContaining haveSimpleNameEndingWith haveSimpleNameNotContaining haveSimpleNameNotEndingWith haveSimpleNameNotStartingWith haveSimpleNameStartingWith implement notBe notBeAnnotatedWith notBeAnonymousClasses notBeAssignableFrom notBeAssignableTo notBeEnums notBeInnerClasses notBeInterfaces notBeLocalClasses notBeMemberClasses notBeMetaAnnotatedWith notBeNestedClasses notBePackagePrivate notBePrivate notBeProtected notBePublic notBeRecords

Slide 87

Slide 87 text

@ToddGinsberg Class Conditions notBeRecords notBeTopLevelClasses notHaveFullyQualifiedName notHaveModifier notHaveSimpleName notImplement onlyAccessClassesThat onlyAccessFieldsThat onlyAccessMembersThat onlyCallCodeUnitsThat onlyCallConstructorsThat onlyCallMethodsThat onlyDependOnClassesThat onlyHaveDependentClassesThat resideInAnyPackage resideInAPackage resideOutsideOfPackage resideOutsideOfPackages setField setFieldWhere transitivelyDependOnClassesThat

Slide 88

Slide 88 text

@ToddGinsberg Positive or Negative Inclusion classes() .that() .areAnnotatedWith(Controller.class) .or().areAnnotatedWith(RestController.class) .should() .resideInAPackage("..controller..") .because("controllers belong in a controller package");

Slide 89

Slide 89 text

@ToddGinsberg Positive or Negative Inclusion noClasses() .that() .areAnnotatedWith(Controller.class) .or().areAnnotatedWith(RestController.class) .should() .resideOutsideOfPackage("..controller..") .because("controllers belong in a controller package");

Slide 90

Slide 90 text

@ToddGinsberg Methods… methods() .that() .areDeclaredInClassesThat() .haveNameMatching(".*Utils?") .should() .beStatic();

Slide 91

Slide 91 text

@ToddGinsberg Fields… fields() .that() .areStatic() .should() .beFinal();

Slide 92

Slide 92 text

@ToddGinsberg Use Case: Layered Architecture API Layer Service Layer Data Layer Controller Service Controller Service Repository Repository

Slide 93

Slide 93 text

@ToddGinsberg Use Case: Layered Architecture The hard way…

Slide 94

Slide 94 text

@ToddGinsberg Use Case: Layered Architecture The hard way… noClasses() .that() .resideOutsideOfPackage("..controller..") .should() .accessClassesThat() .resideInAnyPackage("..controller..");

Slide 95

Slide 95 text

@ToddGinsberg Use Case: Layered Architecture The hard way… classes() .that() .resideInAnyPackage("..service..") .should() .onlyBeAccessed() .byAnyPackage("..controller..");

Slide 96

Slide 96 text

@ToddGinsberg Use Case: Layered Architecture The easy way… layeredArchitecture()

Slide 97

Slide 97 text

@ToddGinsberg Use Case: Layered Architecture The easy way… layeredArchitecture() .layer("Controller").definedBy("..controller..") .layer("Service").definedBy("..service..") .layer("Data").definedBy("..data..")

Slide 98

Slide 98 text

@ToddGinsberg Use Case: Layered Architecture The easy way… layeredArchitecture() .layer("Controller").definedBy("..controller..") .layer("Service").definedBy("..service..") .layer("Data").definedBy("..data..") .whereLayer("Controller").mayNotBeAccessedByAnyLayer() .whereLayer("Service").mayOnlyBeAccessedByLayers("Controller") .whereLayer("Data").mayOnlyBeAccessedByLayers("Service");

Slide 99

Slide 99 text

@ToddGinsberg Use Case: Onion Architecture The easy way… onionArchitecture()

Slide 100

Slide 100 text

@ToddGinsberg Use Case: Onion Architecture The easy way… onionArchitecture() .domainModels("..model..") .domainServices("..service..") .applicationServices("..app..") .adapter("cli", "..cli..") .adapter("data", "..data..") .adapter("rest", "..rest..");

Slide 101

Slide 101 text

@ToddGinsberg Use Case: PlantUML Diagram

Slide 102

Slide 102 text

@ToddGinsberg Use Case: PlantUML Diagram @startuml [Address] <<..address..>> [Customer] <<..customer..>> [Order] <<..order..>> #white/PowderBlue [Products] <<..product..>> #white/PowderBlue [Product Catalog] <<..catalog..>> as catalog #PowderBlue [Product Import] <<..importer..>> as import [XML] <<..xml.processor..>> <<..xml.types..>> as xml [Order] ---> [Customer] : is placed by [Order] --> [Products] [Customer] --> [Address] [Products] <--[#green]- catalog import -left-> catalog : parse products import --> xml @enduml

Slide 103

Slide 103 text

@ToddGinsberg Use Case: PlantUML Diagrams

Slide 104

Slide 104 text

@ToddGinsberg Use Case: PlantUML Diagrams URL myDiagram = getClass().getResource("project.puml");

Slide 105

Slide 105 text

@ToddGinsberg Use Case: PlantUML Diagrams URL myDiagram = getClass().getResource("project.puml"); classes() .should( adhereToPlantUmlDiagram( myDiagram, consideringAllDependencies() ) );

Slide 106

Slide 106 text

@ToddGinsberg ArchUnit-Provided Rules ● Don’t use standard streams (System.out, System.in, printStackTrace) ● Don’t throw generic exceptions (Throwable, Exception, RuntimeException) ● Don’t use java.util.logging ● Don’t use Joda Time ● Prevent field-level autowiring (@Autowired, @Value, @Inject, @Resource, etc)

Slide 107

Slide 107 text

@ToddGinsberg ArchUnit-Provided Rules noClasses() .should(ACCESS_STANDARD_STREAMS);

Slide 108

Slide 108 text

@ToddGinsberg ArchUnit Works Great For… Photo by Dawid Zawiła on Unsplash

Slide 109

Slide 109 text

@ToddGinsberg What About Legacy Applications? This is a README. Pay attention to it! This repository is not a place of honor... no highly esteemed code is kept here. What is here was dangerous and repulsive to us. This repository is best shunned and left untouched.

Slide 110

Slide 110 text

@ToddGinsberg Use Case: Freezing Rules layeredArchitecture() .layer("Controller").definedBy("..controller..") .layer("Service").definedBy("..service..") .layer("Data").definedBy("..data..") .whereLayer("Controller").mayNotBeAccessedByAnyLayer() .whereLayer("Service").mayOnlyBeAccessedByLayers("Controller") .whereLayer("Data").mayOnlyBeAccessedByLayers("Service");

Slide 111

Slide 111 text

@ToddGinsberg Use Case: Freezing Rules FreezingArchRule.freeze( layeredArchitecture() .layer("Controller").definedBy("..controller..") .layer("Service").definedBy("..service..") .layer("Data").definedBy("..data..") .whereLayer("Controller").mayNotBeAccessedByAnyLayer() .whereLayer("Service").mayOnlyBeAccessedByLayers("Controller") .whereLayer("Data").mayOnlyBeAccessedByLayers("Service") );

Slide 112

Slide 112 text

@ToddGinsberg Use Case: Freezing Rules archunit.properties

Slide 113

Slide 113 text

@ToddGinsberg Use Case: Freezing Rules archunit.properties Run Tests

Slide 114

Slide 114 text

@ToddGinsberg Use Case: Freezing Rules archunit.properties Run Tests stored.rules uuid-named files stored.rules uuid-named files

Slide 115

Slide 115 text

@ToddGinsberg Use Case: Freezing Rules My Code +1

Slide 116

Slide 116 text

@ToddGinsberg Use Case: Freezing Rules Run Tests My Code +1

Slide 117

Slide 117 text

@ToddGinsberg Use Case: Freezing Rules My Code -1

Slide 118

Slide 118 text

@ToddGinsberg Use Case: Freezing Rules Run Tests stored.rules uuid-named files My Code -1

Slide 119

Slide 119 text

@ToddGinsberg Testing Our Rules classes() .that() .resideInAnyPackage("that doesn’t exist") .should() // ...

Slide 120

Slide 120 text

@ToddGinsberg Testing Our Rules classes() .that() .resideInAnyPackage("that doesn’t exist") .should() // ... This rule will FAIL if should() operates on an empty set of classes!

Slide 121

Slide 121 text

@ToddGinsberg Testing Our Rules classes() .that() .resideInAnyPackage("that doesn’t exist") .should() // Some fun conditions here .allowEmptyShould(true)

Slide 122

Slide 122 text

@ToddGinsberg Testing Our Rules ArchRule auroraBorealisLocationAndTimeOfDay = //...

Slide 123

Slide 123 text

@ToddGinsberg Testing Our Rules ArchRule auroraBorealisLocationAndTimeOfDay = //... JavaClasses classes = new ClassFileImporter().importClasses(SkinnersKitchen.class);

Slide 124

Slide 124 text

@ToddGinsberg Testing Our Rules ArchRule auroraBorealisLocationAndTimeOfDay = //... JavaClasses classes = new ClassFileImporter().importClasses(SkinnersKitchen.class); auroraBorealisLocationAndTimeOfDay.check(classes)

Slide 125

Slide 125 text

@ToddGinsberg Testing Our Rules ArchRule auroraBorealisLocationAndTimeOfDay = //... JavaClasses classes = new ClassFileImporter().importClasses(SkinnersKitchen.class); assertThatThrownBy( () -> auroraBorealisLocationAndTimeOfDay.check(classes) ) .isInstanceOf(AssertionError.class) .hasMessageStartingWith("Architecture Violation");

Slide 126

Slide 126 text

@ToddGinsberg Why Use ArchUnit? ● Quickly enforce architectural rules from within our project.

Slide 127

Slide 127 text

@ToddGinsberg Why Use ArchUnit? ● Quickly enforce architectural rules from within our project. ● Runs as part of test cycle for early, inescapable feedback.

Slide 128

Slide 128 text

@ToddGinsberg Why Use ArchUnit? ● Quickly enforce architectural rules from within our project. ● Runs as part of test cycle for early, inescapable feedback. ● Documents intent.

Slide 129

Slide 129 text

@ToddGinsberg Why Use ArchUnit? ● Quickly enforce architectural rules from within our project. ● Runs as part of test cycle for early, inescapable feedback. ● Documents intent. ● Helps move legacy systems towards enforced standards.

Slide 130

Slide 130 text

Painless Integration Tests

Slide 131

Slide 131 text

Unit Tests Integration Tests E2E Tests Faster Slower Isolated Coupled

Slide 132

Slide 132 text

Unit Tests

Slide 133

Slide 133 text

Unit Tests Manual Tests (ewww)

Slide 134

Slide 134 text

Unit Tests Manual Tests (ewww) Integration Tests (broken)

Slide 135

Slide 135 text

@ToddGinsberg Why Is Integration Testing So Difficult?

Slide 136

Slide 136 text

@ToddGinsberg Why Is Integration Testing So Difficult? Our Application

Slide 137

Slide 137 text

@ToddGinsberg Our Machine What About An Embedded DB? Our Application

Slide 138

Slide 138 text

@ToddGinsberg Our Machine What About An Embedded DB? H2 Our Application

Slide 139

Slide 139 text

@ToddGinsberg Our Machine Run Our Own Database? Our Application

Slide 140

Slide 140 text

@ToddGinsberg Central DB Our Machine What About A Shared Instance? Our Application

Slide 141

Slide 141 text

@ToddGinsberg Central DB Our Machine What About A Shared Instance? Our Application Randos

Slide 142

Slide 142 text

@ToddGinsberg Central DB Our Machine What About A Shared Instance? Our Application Randos

Slide 143

Slide 143 text

@ToddGinsberg Central DB Our Machine What About A Shared Instance? Our Application Randos V1 V1

Slide 144

Slide 144 text

@ToddGinsberg Central DB Our Machine What About A Shared Instance? Our Application Randos V1 V2

Slide 145

Slide 145 text

@ToddGinsberg Our Machine What About A Container? Our Application

Slide 146

Slide 146 text

@ToddGinsberg Our Machine What About A Container? Our Application

Slide 147

Slide 147 text

@ToddGinsberg Testcontainers To The Rescue! https://testcontainers.org

Slide 148

Slide 148 text

@ToddGinsberg How Does It Work?

Slide 149

Slide 149 text

@ToddGinsberg Docker Daemon How Does It Work?

Slide 150

Slide 150 text

@ToddGinsberg Docker Daemon How Does It Work? Our Dependencies

Slide 151

Slide 151 text

@ToddGinsberg Docker Daemon How Does It Work? Docker REST API Our Dependencies

Slide 152

Slide 152 text

@ToddGinsberg Docker Daemon How Does It Work? Docker REST API Docker CLI Our Dependencies

Slide 153

Slide 153 text

@ToddGinsberg Docker Daemon How Does It Work? Docker REST API Our Application Our Dependencies

Slide 154

Slide 154 text

@ToddGinsberg Docker Daemon How Does It Work? Docker REST API Our Application Our Dependencies Ryuk

Slide 155

Slide 155 text

@ToddGinsberg Testcontainer Requirements 1) Docker Environment

Slide 156

Slide 156 text

@ToddGinsberg Testcontainer Requirements 1) Docker Environment 2) Java 8+

Slide 157

Slide 157 text

@ToddGinsberg Testcontainer Requirements 1) Docker Environment 2) Java 8+ 3) JUnit4 or JUnit5 or Spock

Slide 158

Slide 158 text

@ToddGinsberg Testcontainer Requirements 1) Docker Environment 2) Java 8+ 3) JUnit4 or JUnit5 or Spock

Slide 159

Slide 159 text

@ToddGinsberg Docker Environment

Slide 160

Slide 160 text

@ToddGinsberg Docker Environment

Slide 161

Slide 161 text

@ToddGinsberg Docker Environment

Slide 162

Slide 162 text

@ToddGinsberg Docker Environment

Slide 163

Slide 163 text

@ToddGinsberg Docker Environment

Slide 164

Slide 164 text

@ToddGinsberg Adding To Our Project testImplementation( 'org.testcontainers:testcontainers:1.16.3', 'org.testcontainers:junit-jupiter:1.16.3' )

Slide 165

Slide 165 text

@ToddGinsberg Adding To Our Project org.testcontainers testcontainers 1.16.3 test org.testcontainers junit-jupiter 1.16.3 test

Slide 166

Slide 166 text

@ToddGinsberg Use Case: Spring Talking to Redis Spring Application

Slide 167

Slide 167 text

Redis Integration Test Demo

Slide 168

Slide 168 text

@ToddGinsberg Use Case: Database Tests @SpringBootTest public class PostgresRelatedTest { @Autowired private DonutRepository repository; // ??? }

Slide 169

Slide 169 text

@ToddGinsberg Use Case: Database Tests @SpringBootTest @Testcontainers public class PostgresRelatedTest { @Autowired private DonutRepository repository; // ??? }

Slide 170

Slide 170 text

@ToddGinsberg Use Case: Database Tests @Autowired private DonutRepository repository;

Slide 171

Slide 171 text

@ToddGinsberg Use Case: Database Tests @Autowired private DonutRepository repository; @Container private static PostgreSQLContainer database = new PostgreSQLContainer("postgres:14.2");

Slide 172

Slide 172 text

@ToddGinsberg Use Case: Database Tests @Autowired private DonutRepository repository; @Container private static PostgreSQLContainer database = new PostgreSQLContainer("postgres:14.2"); @DynamicPropertySource public static void props(DynamicPropertyRegistry registry) { registry.add("spring.datasource.url", database::getJdbcUrl); registry.add("spring.datasource.username", database::getUsername); registry.add("spring.datasource.password", database::getPassword); }

Slide 173

Slide 173 text

@ToddGinsberg Use Case: Database Tests @Autowired private DonutRepository repository; @Container private static PostgreSQLContainer database = new PostgreSQLContainer("postgres:14.2") .withDatabaseName("setec_astronomy") .withUsername("mbishop") .withPassword("T00ManyS3crets");

Slide 174

Slide 174 text

@ToddGinsberg Use Case: Database Tests @Autowired private DonutRepository repository; @Container private static PostgreSQLContainer database = new PostgreSQLContainer("postgres:14.2") .withConnectionTimeoutSeconds(20) .withStartupTimeoutSeconds(20);

Slide 175

Slide 175 text

@ToddGinsberg Use Case: Database Tests @Autowired private DonutRepository repository; @Container private static PostgreSQLContainer database = new PostgreSQLContainer("postgres:14.2") .withInitScript("src/init.sql");

Slide 176

Slide 176 text

@ToddGinsberg Supported Database Modules JDBC R2DBC Cassandra CockroachDB Clickhouse DB2 Dynalite Influx MariaDB MongoDB MS SQL Server MySQL Neo4j Oracle-XE OrientDB Postgres Presto Trinio

Slide 177

Slide 177 text

@ToddGinsberg Supported Database Modules JDBC R2DBC Cassandra CockroachDB Clickhouse DB2 Dynalite Influx MariaDB MongoDB MS SQL Server MySQL Neo4j Oracle-XE OrientDB Postgres Presto Trinio

Slide 178

Slide 178 text

@ToddGinsberg Use Case: Database Tests (But Simpler!) jdbc:postgresql://localhost:5432/somedb

Slide 179

Slide 179 text

@ToddGinsberg Use Case: Database Tests (But Simpler!) jdbc:tc:postgresql:14.2://localhost:5432/somedb

Slide 180

Slide 180 text

@ToddGinsberg Use Case: Database Tests (But Simpler!) jdbc:tc:postgresql:14.2://localhost:5432/somedb Our Application Testcontainers JDBC Driver Data Layer

Slide 181

Slide 181 text

@ToddGinsberg Use Case: Database Tests (But Simpler!) jdbc:tc:postgresql:14.2://localhost:5432/somedb Our Application Testcontainers JDBC Driver Data Layer

Slide 182

Slide 182 text

@ToddGinsberg Use Case: Database Tests (But Simpler!) jdbc:tc:postgresql:14.2://localhost:5432/somedb Our Application Testcontainers JDBC Driver Data Layer

Slide 183

Slide 183 text

@ToddGinsberg Use Case: Database Tests (But Simpler!) jdbc:tc:postgresql:14.2://localhost:5432/somedb Our Application Testcontainers JDBC Driver PosgreSQL JDBC Driver Data Layer

Slide 184

Slide 184 text

@ToddGinsberg Use Case: Database Tests (But Simpler!) jdbc:tc:postgresql:14.2://localhost:5432/somedb Our Application Testcontainers JDBC Driver PosgreSQL JDBC Driver Data Layer

Slide 185

Slide 185 text

@ToddGinsberg Use Case: Database Tests (But Simpler!) @SpringBootTest public class JdbcUrlTest { static { } }

Slide 186

Slide 186 text

@ToddGinsberg Use Case: Database Tests (But Simpler!) @SpringBootTest public class JdbcUrlTest { static { System.setProperty( "spring.datasource.url", "jdbc:tc:postgresql:14.2://localhost:5432/somedb" ); } }

Slide 187

Slide 187 text

@ToddGinsberg Use Case: Database Tests (But Simpler!) @SpringBootTest public class JdbcUrlTest { static { System.setProperty( "spring.datasource.url", "jdbc:tc:postgresql:14.2://localhost:5432/somedb" ); } }

Slide 188

Slide 188 text

@ToddGinsberg Use Case: Database Tests (But Simpler!) @SpringBootTest public class JdbcUrlTest { static { System.setProperty( "spring.datasource.url", "jdbc:tc:postgresql:14.2://localhost:5432/" ); } }

Slide 189

Slide 189 text

@ToddGinsberg Use Case: Database Tests (But Simpler!) @SpringBootTest public class JdbcUrlTest { static { System.setProperty( "spring.datasource.url", "jdbc:tc:postgresql:14.2://localhost:5432/" ); } }

Slide 190

Slide 190 text

@ToddGinsberg Use Case: Database Tests (But Simpler!) @SpringBootTest public class JdbcUrlTest { static { System.setProperty( "spring.datasource.url", "jdbc:tc:postgresql:14.2:///" ); } }

Slide 191

Slide 191 text

@ToddGinsberg JDBC Init Script Options… jdbc:tc:postgresql:14.2:///

Slide 192

Slide 192 text

@ToddGinsberg JDBC Init Script Options… jdbc:tc:postgresql:14.2:/// ?TC_INITSCRIPT=path/init.sql

Slide 193

Slide 193 text

@ToddGinsberg JDBC Init Script Options… jdbc:tc:postgresql:14.2:/// ?TC_INITSCRIPT=file:src/init.sql

Slide 194

Slide 194 text

@ToddGinsberg JDBC Init Script Options… jdbc:tc:postgresql:14.2:/// ?TC_INITFUNCTION=JdbcTest::initFunction

Slide 195

Slide 195 text

@ToddGinsberg JDBC Init Script Options… jdbc:tc:postgresql:14.2:/// ?TC_INITFUNCTION=JdbcTest::initFunction public class JdbcTest { public static void initFunction(Connection connection) throws SQLException { // Flyway, Liquibase, etc... } }

Slide 196

Slide 196 text

@ToddGinsberg Use Case: Database Tests (But Simpler!) @SpringBootTest public class JdbcUrlTest { static { System.setProperty( "spring.datasource.driverClassName", "org.testcontainers.jdbc.ContainerDatabaseDriver" ); System.setProperty( "spring.datasource.url", "jdbc:tc:postgresql:14.2:///" ); } }

Slide 197

Slide 197 text

@ToddGinsberg Use Case: Database Tests (But Simpler!) @SpringBootTest public class JdbcUrlTest { static { System.setProperty( "spring.datasource.driverClassName", "org.testcontainers.jdbc.ContainerDatabaseDriver" ); System.setProperty( "spring.datasource.url", "jdbc:tc:postgresql:14.2:///" ); } }

Slide 198

Slide 198 text

@ToddGinsberg More Than One Container OurFirstTestClass

Slide 199

Slide 199 text

@ToddGinsberg More Than One Container OurFirstTestClass OurSecondTestClass

Slide 200

Slide 200 text

@ToddGinsberg More Than One Container OurFirstTestClass OurSecondTestClas s AbstractBaseTest

Slide 201

Slide 201 text

@ToddGinsberg In A Base Class For All Tests public abstract class AbstractBaseTest { static PostgreSQLContainer database; static GenericContainer redis; static { database = new PostgreSQLContainer("postgres:14.2"); database.start(); redis = new GenericContainer("redis:6.4.2-alpine"); redis.start(); } }

Slide 202

Slide 202 text

MockServer Demo

Slide 203

Slide 203 text

@ToddGinsberg More Supported Modules Azure Docker Compose ElasticSearch GCloud HiveMQ K3S Kafka LocalStack MockServer Nginx Apache Pulsar RabbitMQ Solr Toxiproxy Hashicorp Vault WebDriver

Slide 204

Slide 204 text

@ToddGinsberg More Supported Modules Azure Docker Compose ElasticSearch GCloud HiveMQ K3S Kafka LocalStack MockServer Nginx Apache Pulsar RabbitMQ Solr Toxiproxy Hashicorp Vault WebDriver

Slide 205

Slide 205 text

@ToddGinsberg More Supported Modules Azure Docker Compose ElasticSearch GCloud HiveMQ K3S Kafka LocalStack MockServer Nginx Apache Pulsar RabbitMQ Solr Toxiproxy Hashicorp Vault WebDriver

Slide 206

Slide 206 text

@ToddGinsberg More Supported Modules Azure Docker Compose ElasticSearch GCloud HiveMQ K3S Kafka LocalStack MockServer Nginx Apache Pulsar RabbitMQ Solr Toxiproxy Hashicorp Vault WebDriver

Slide 207

Slide 207 text

@ToddGinsberg Why Use Testcontainers? ● Isolated environments against real components

Slide 208

Slide 208 text

@ToddGinsberg Why Use Testcontainers? ● Isolated environments against real components ● App start + DB created in a single test

Slide 209

Slide 209 text

@ToddGinsberg Why Use Testcontainers? ● Isolated environments against real components ● App start + DB created in a single test ● Easier to test failure cases

Slide 210

Slide 210 text

@ToddGinsberg Why Use Testcontainers? ● Isolated environments against real components ● App start + DB created in a single test ● Easier to test failure cases ● Run tests offline*

Slide 211

Slide 211 text

@ToddGinsberg Why Use Testcontainers? ● Isolated environments against real components ● App start + DB created in a single test ● Easier to test failure cases ● Run tests offline* ● Code and Integration Tests in the same PR and repo

Slide 212

Slide 212 text

@ToddGinsberg Smuggle Fun Technologies In With Tests!

Slide 213

Slide 213 text

In Conclusion…

Slide 214

Slide 214 text

@ToddGinsberg https://archunit.org

Slide 215

Slide 215 text

@ToddGinsberg https://testcontainers.org

Slide 216

Slide 216 text

@ToddGinsberg @ToddGinsberg todd@ginsberg.com https://todd.ginsberg.com Thank You!