Improve Deal Governance in IT Architecture Documentation with airSlate SignNow

How to create outlook signature

hello and welcome to software architecture Monday my name is Mark Richards I'm a hands-on software architect and also the founder of developer to architect comm in today's lesson number 68 we'll take a look at automating architecture governance in lesson 55 we learned about architecture decisions and the use of architecture decision records Michael Nygaard had coined these and he said that we will keep a collection of Records for architectural significant decisions and these are decisions that we make as an architect and we learned that using a dr's in lesson 55 architecture decision records was a great way of being able not only to document an architecture decision but also to form a justification now in this lesson number 68 we're going to take one step further and see how to ensure the compliance of these architecture decisions that we make in an automated fashion and I want to show you two open source frameworks that you can use the first is something called arc units now this is for Java and you can find it at arc unit org the second is net arc test and this is for C sharp which what Ben Morris basically did was taken a port from arc unit and converted it so that we can have the same kind of automated tests for C sharp as we do for Java so arc unit will be for Java net arc test for c-sharp let's take a look at how to apply both of these and the first I want to do is let's take a look at a simple architecture decision here and a traditional layered architecture we have presentation business services persistence and database what we have is an architecture decision which hopefully is documented and justified in an architecture decision record again if you haven't seen that take a look at lesson 55 but only the business and service layers can access the persistence layer to control change throughout the architecture in other words we don't want the presentation layer to access the persistence layer or the data based directly and notice we have a closed layered architecture well let's try Ark unit first and actually see how we can write a programmatic test so that we can automate the governance of this particular architecture decision so the first thing we're going to do in arc unit is I'm going to define a class here called architecture governance tests and I need to basically load up those classes and so I'm going to import packages and this is all using the arc unit API I use the class file importer dot import packages for comm my company my app and so that's basically the route package structure now let's write a test to govern this so the first thing we're going to do is I'm going to name this something that we can actually I love naming these by the way and this is how I name my tests to basically describe the architecture decision in other words presentation layer cannot access persistence layer and so let's actually utilize the API and see who we can automate this so notice how this says no classes dot that dot reside in a package presentation and so this is anything in presentation should dot accesses classes that reside in a package persistence so notice that no classes in the third line there no classes that reside in a package presentation should that accesses classes that reside in a package persistence and then we have a because clause which I really love and because point is when somebody from the presentation layer team ends up talking directly to persistence this test will fail and we want to tell the person why and because clause will come out on a failed test to say we have a closed layered architecture to control changes made in the database and persistence layer because we are incurring a lot of changes therefore persistence layer can only communicate with the business layer and then we say check and so this is the only this is all the code there is and so this would run based on a trigger through either a commits or a deployment wherever you have the test hooked in now let's take a look at another test because I'm going to show you this in c-sharp and so using net arc test let's do the same exact thing and so I'm going to create a namespace governance rule structure and now let's see this here's my architecture governance tests presentation layer cannot access persistence layer in this name of this particular test and now what we have is this types in the current domain that reside in a namespace micom dot my app dot presentation should not have a dependency on my comm my app persistence and then we get the result and past thee is successful into the result variable and so you can kind of see it's a little bit different style of API but still very very mmm and intuitive and so let's take a look at another example because I want to show you how sophisticated some of these tests can be so here we've got an architecture decision that basically says that all shared objects used by business objects in the business layer should reside in the shared services layer in order to isolate and contain shared functionality so let's see how we can automate this let's use arc unit for this that's what I'm going to do it's gonna create a test here's the method shared services should reside in a services layer hmm how do we enforce the fact that classes reside in a specific layer or a specific component in a domain driven design so let's do this classes dot that that are annotated with shared service and so correspondingly in net our tests we can use an attribute in c-sharp instead but here in Java we use annotations and so those classes that are annotated with shared service to identify that as a shared kind of component dot should reside in a package services and again because all shared services class is reside in the business to be able to isolate that dot check now there's one other example I want to provide and that is kind of a full-featured aspect of a layered architecture by the way that I do use also for modular monoliths now here we have a traditional layered architecture and our architecture decision is to respect the open and closed layers in order to control change throughout the architecture now notice we've got closed layers which means that the presentation must go through business before getting to anywhere else business because services layer is open can hop over services but has to go to persistence can't talk to the database directly and so we've got open and closed layers let's take a look at another kind of mechanism within our qunit that we can actually apply automated compliance layer dependencies are respected is the name so layered architecture now here's what the interesting thing is we can still use this for domain driven design in our modular monoliths by a component being quote a layer but I'll show you how this happens so the very first thing we do in this kind of a test is we describe our architecture for example layered architecture dot layer presentation defined by that package structure my app dot presentation layer business defined by my app dot business layer services defined by my app services and layer persistence defined by persistence so we can actually describe either all of our components or modules or our layers now we can apply the rules are you ready we're layer business may only be accessed by layers presentation notice services may only be accessed by layers business that precludes presentation from hopping over that closed layer whereas persistence may only be accessed by layers business and services and so both services and business can get to persistence and now we have our because Klaus when this ends up failing and says is pretty cool because now we can describe components as layers as well and then the wear layer just substitute component and so now we can actually have access rules to various components really really powerful there are so many examples and API examples in both Ark unit and net Ark test and so for Ark unit here's three links that you can use I showed the examples here where you can go directly to the example tests and also the user guide which has the API my recommendation everyone you can go through the API but it's it's it's pretty exhaustive um I prefer to actually go through the examples so that you can actually see the kinds of things that you can actually automate for compliance now for those of you in c-sharp with net Ark test Ben Morris has done the same thing and so if you go to github and net arc test tree master samples you can see all sorts of other examples in my opinion it's the best way to learn of the API I'm also that Jar Farrar in arc unit and is available on maven and you can do a new get on network test out rules in c-sharp so for other information you can certainly go to developer to architect these lessons are housed in software architecture Monday at developer to architect comm slash lessons I do offer private training classes and which you can go to on the training link and also you could see when I'm going to be available either through online training or also conferences and public events by going to my upcoming events page so this has been lesson 68 automating architecture governance I would encourage you to take a look at those links to really kind of go deep in terms of how to use this to be able to automate some of the architecture decisions that you're making and so this has been software architecture Monday I get my name is Mark Richards thank you so much for listening