Improving software quality with an automated build process

Transcription

1 Software architecture for developers What is software architecture? What is the role of a software architect? How do you define software architecture? How do you share software architecture? How do you deliver software architecture? Improving software quality with an automated build process

2 @simonbrown on Twitter

3 Training itjersey & itguernsey Books Conferences

4 definition Why Software Projects Fail Who should do all of this? Simon Brown Hands-on software architect It should be the architect (somebody has to do it and that s why we get paid the big bucks) The role of a software architect Management of non-functional requirements Architecture Technology selection Architecture evaluation Ownership of the bigger picture Leadership Architecture collaboration Coaching and mentoring Quality assurance Why software projects fail... Definition This is what we write about on our website... Design, development and testing...architects are here Delivery to help, not to hinder A hands-on software architect can be invaluable for preventing project failure A hands-on software architect can be invaluable for driving project success Software projects fail for a number of reasons Iterative and agile techniques solve some problems... Website London User Group Monthly mix of presentation and discussion Google Group

5 The role of a software architect Management of non-functional requirements Architecture definition Ownership of the bigger picture Leadership Technology selection Architecture evaluation Coaching and mentoring Quality assurance Architecture collaboration Definition Design, development and testing Delivery

6 Our system

7 Internet banking system predominantly built on the Microsoft.NET platform C# code on the.net 3.5 framework

8 It provides a web facade over existing business systems

9 Distributed architecture

10 ASP.NET websites

11 Windows Communication Foundation services in the middle-tier

12 SQL Server database

13 XML/TCP connectivity to the back-end banking system

14 80+ ASP.NET pages

15 30,000+ lines of C#.NET code

16 650+ classes

17 4 WCF services with 100+ service operations between them

18 50+ SQL stored procedures

19 5+ man-years of development (it s not a massive system but there is some complexity in there) Let us know if you d like a BCS session on the architecture & design

20 Why is quality important?

21 Reputation of the business (e.g. driven by customer satisfaction)

22 Service level agreements key performance indicators & (e.g. between suppliers, between systems, non-functional requirements, etc...)

23 Reputation of the development team It s important that we know what we re releasing It s important that the software we release works That s us!

24 Our software development tools and processes

25 Visual Studio 2008

26 AnkhSVN TestDriven.Net

27 NCover (& NCoverExplorer) We use NUnit for writing our tests

28 Low-level tests for classes and components Unit & integration tests Functional tests across container boundaries We have ~3000 automated tests in total

29 We re lucky to have a dedicated team member running the tests several times a day

30 CruiseControl.NET Development Server Web-tier Development Server Middle-tier Development Server Database Subversion Source code repository CruiseControl.NET gets the source code from the repository and runs the build script; compiling, testing, packaging and installing the software

31 Build-Test-Run when we commit code to the repository Continuous & nightly builds Continuous build + longer running integration tests

32 This is what happens when we break something...

33 Code branching

34 We follow Subversion project guidelines for repository layout

35 Subversion Source code repository Internet Banking system /branches /live bug fixes /work-stream 1 /work-stream 2 /tags /trunk All work is performed on branches This is the main development stream Chapter 5: Repository Administration - Adding Projects

36 New projects & branches in CruiseControl.NET are managed through a bespoke interface

37 The build process

38 Things to do when building a release 1. Compile the code in release mode 2. Publish files to IIS 3. Maybe check it works

39 Automation is a good thing

40 d:\subversion\ib4\trunk> nant NAnt 0.85 (Build ; release; 14/10/2006) Copyright (C) Gerry Shaw Buildfile: file:///d:/subversion/ib4/trunk/ib.build Target framework: Microsoft.NET Framework 2.0 Target(s) specified: CruiseControlCheckin [loadtasks] Scanning assembly "NAnt.Contrib.Tasks" for extensions. [loadtasks] Scanning assembly "NCoverExplorer.NAntTasks" for extensions.... Nant is for developers We also use NAntContrib for lots of extra automation goodness! as well as CruiseControl.NET

41 Release tasks 1. Setup the build and get build metadata 2. Create virtual directories on IIS 3. Clean existing binaries and other resources 4. Run a debug build 5. Execute the unit tests 6. Execute the integration tests and diagnostics* 7. Generate a code coverage report 8. Run a release build and create release packages 9. Install the middle-tier applications 10. Install the web-tier application 11. Run a quick smoke test 12. Create the release bundle * nightly build only

42 <?xml version="1.0" encoding="utf-8"?> <version> <ib.version>ib4.1.0g</ib.version> </version> Build metadata is generated and included in the assemblies

43 <target name="createvirtualdirectories"> <mkiisdir dirpath="${base.dir}/ib.web/ib.web" website="default Web Site" vdirname="ib.web" />... </target> IIS virtual directory creation is automated

44 /// <summary> /// The SetUp method in this class runs before all other tests in this namespace /// to recreate the Banner table and stored procedures. /// </summary> [SetUpFixture] public class BannerSetUp : AbstractMessagingIntegrationTests { [SetUp] public void SetUp() { string path // create tables ExecuteSqlScript(string.Format(@"{0}Tables\Banner.sql", path)); // create stored procedures ExecuteSqlScript(string.Format(@"{0}StoredProcedures\GetBanner.sql", path)); ExecuteSqlScript(string.Format(@"{0}StoredProcedures\GetBanners.sql", path)); ExecuteSqlScript(string.Format(@"{0}StoredProcedures\UpdateBanner.sql", path)); } } // and load some initial data ExecuteSqlScript(string.Format(@"{0}InitialBanners.sql", path)); Database objects are scripted and those scripts are executed during the integration tests

45 Diagnostics Is everything installed? Can we see all of our services? Are the external systems up and running? Are all deployed components at the same version? Do all tiers have the required configuration? Are all tiers running the correct.net runtime and framework? Our basic diagnostic checks are automated and included in the build

46 <target name="smoketest"> <exec program="jmeter.bat" basedir="software\jakarta-jmeter-2.3.2\bin" commandline="-n -t ib.web\ib-smoke-test.jmx -Jib4.users=personal,... -Jib4.numberOfUsers=6 -Jib4.protocol=http -Jib4.host=${ib.servername} -Jib4.context=${ib.context} -Jib4.password=******** -Jib4.memorable=*******" output="${build.dir}\smoketest.log" /> <loadfile file="${build.dir}\smoketest.log" property="smoketestlog" /> <fail unless="${string::contains(smoketestlog, '[personal] Logged off')}" message="smoke test failed for personal user" /> </target> A quick bit of automated smoke testing

47 A developer s guide to load testing; 28th January 2010

48 How much does this all cost?

49 1-2 days for a basic automated build script and continuous integration environment Virtual machines make excellent continuous integration servers

50 1-2 weeks for a comprehensive build script and continuous integration environment

51 The future?

52 Keep driving forward, spotting opportunities for automation where it can add value

53 // todo: scriptable releases d:\release> nant install NAnt 0.85 (Build ; release; 14/10/2006) Copyright (C) Gerry Shaw Installing web-tier components... Installing middle-tier components... Installing database components... Modifying configuration for live environment... Running post-install diagnostics... Complete; version IB4.1.0.g has been installed. Automated rollbacks can be tricky

54 Let s wrap up

55 Build automation is relatively easy to do and the benefits are huge

56 1. Compile the code in release mode 2. Publish files to IIS 3. Maybe check it works From hope to improved software quality confidence and in our releases 1. Setup the build and get build metadata 2. Create virtual directories on IIS 3. Clean existing binaries and other resources 4. Run a debug build 5. Execute the unit tests 6. Execute the integration tests and diagnostics 7. Generate a code coverage report 8. Run a release build and create release packages 9. Install the middle-tier applications 10. Install the web-tier application 11. Run a quick smoke test 12. Create the release bundle

57 @simonbrown on Twitter Thanks for listening. Any questions? Software architecture for developers