Building quality software, with low defect counts, conformance to specifications and a clean code base is an important goal for any growing software company. Really high quality can only be maintained by introducing process & automation into the development process. This talk gives an overview of different tools that can help increase software quality, using a Ruby on Rails app as the example environment.

2. BEYOND HACKING
Crafting Quality Software

3. HOW IS SOFTWARE BUILT IN SMALL TEAMS?
WHY DOES THAT APPROACH NOT SCALE?
WHAT IS QUALITY?
HOW CAN WE ACCOMPLISH IT?

4. FROM CLEAN CODE - A HANDBOOK OF AGILE SOFTWARE CRAFTMANSHIP BY ROBERT C. MARTIN

5. Development Speed
Issues
WHAT IS QUALITY?

6. BUILDING SOFTWARE IN
SMALL TEAMS

7. App
1. Code
2. Deploy
<Code>

8. V 1.0 V 1.0.1 V 1.1 V 1.1.1
Add FeatureFix Bug Fix Bug

9. LIFE IS SIMPLE
LIFE IS GOOD

10. YOU ARE SHIPPING FAST

11. BUT SOMETHING FEELS
WRONG

12. def update(post, title)
@user = User.first
if @user.logged_in
if @user.type == "admin"
@user.type.permissions.each do |permission| {
if (permission == "update_permission") {
if post
begin
post.title = title
post.save
rescue
display_error("This horrible code is not workin!")
end
else
display_error("No Post provided")
end
}
}
elsif @user.type == "other"
return
else
display_error("Invalid User Type")
end
else
#What do here?
end
end
BAD CODE

13. TEAMS GROW,
SOFTWARE GROWS

14. Rock
Bottom
t
code complexity
dev velocity
issues

16. App
1. Code
2. Deploy
<Code>
?
?
!
!
!
?
?
!

17. WHAT NOW?

18. IT’S TIME TO REFACTOR

19. WHERE’S THE SPEC FOR
ALL FEATURES?

20. …

21. HOW CAN WE AVOID THIS?

22. AS SOFTWARE AND TEAM
GROW - ADD PROCESS
AND AUTOMATION

23. HOW CAN WE AVOID CHAOS?
Specification
Automated Testing
Continous Integration
Coding guidelines / Code Analysis
Reproducible development environment

24. (1)
SPECIFY YOUR
APPLICATION

25. TESTS CAN ACT AS
SPECIFICATION!

26. BDD FRAMEWORKS CAN BE USED TO
SPECIFY SOFTWARE
Cucumber Framework: http://cukes.info/
Feature: Search courses
Courses should be searchable by topic
Search results should provide the course code
Scenario: Search by topic
Given there are 240 courses which do not have the topic "biology"
And there are 2 courses, A001 and B205, that each have "biology" as one of the topics
When I search for "biology"
Then I should see the following courses:
| Course code |
| A001 |
| B205 |
Acceptance Test

27. (2)
WRITE AUTOMATED TESTS
(BEFORE WRITING APPLICATION CODE)

28. HOW SHOULD WE TEST?

29. ACCEPTANCE TEST
When it fails, it tells you that the
application is not doing what the
customer expects it to do

30. UNIT TEST
When it fails, it tells you what piece
of your code needs to be fixed

31. EXAMPLE
SignupService.POST(User:"Ben-G", PW:"&47-:#sdö").expect(200)
SignupService.POST(User:"Ben-G", PW:”").expect(400)
SignupService.POST(User:"Ben-G", PW:"&47-:#sdö").expect(200)
PasswordValidator.testPassword("&47-:#sdö").expect(true)
PasswordValidator.testPassword(“”).expect(false)
UsernameValidator.testUsername("Ben-G").expect(true)
PasswordValidator
SignupService
testPassword:Bool
HTTP POST
User: Ben-G
PW: &47-:#sdö
UsernameValidator
testUsername:Bool
SignupService.POST(User:"", PW:"&47-:#sdö").expect(401) UsernameValidator.testUsername("").expect(false)
Acceptance Tests Unit Tests

32. (3)
MEASURE CODE COVERAGE

33. CODE COVERAGE
= % OF CODE COVERED BY TEST

34. (4)
PROVIDE CODING
STYLEGUIDES, AUTOMATE
CODE QUALITY TESTING

35. GITHUB RUBY STYLEGUIDE:
https://github.com/styleguide/ruby

36. RUBOCOP, OCLINT, JSLINT
TOOLS THAT MEASURE
CONFORMANCE TO CODING
GUIDELINES + FIND CODE SMELLS
“static analyzers”

37. CODE
CLIMATE
STATIC
ANALYZER AS
A SERVICE

38. (5)
USE A CONTINUOUS
INTEGRATION SERVER

39. CONTINOUS INTEGRATION
Every time code is pushed:
• Run Static Analyzer
• Run All tests
• Measure Code Coverage
• Run the Build Process
Working product can be shipped at any time!
If anything breaks we find out right away

40. (6)
PROVIDE REPRODUCIBLE
DEVELOPMENT ENVIRONMENT

41. ?
But it works
on my local
machine…

42. MINIMUM CONFIGURATION
git clone git@github.com:MakeGamesWithUs/www-makeschool.git
./server start
./server test
start rails server
run test suite
• Git repository contains the definition of a Docker container
+ a Fig configuration describing services
• App runs in Virtual Machine providing the same
environment for all developers

43. +
VM
define
Rails App
MongoDB
Postgres

44. PUTTING IT ALL TOGETHER

45. Code Coverage Measurements
Unit Tests
enforce
Acceptance Tests
Specification
Low Issue Count
define
support
Refactoring
enable
High Code Quality
drives
enables
Automated Code
Quality Analysis
drives
drives
Development Speed
Reproducible Development
Environment
drives
enables
support
Continous
Integration
{
automates

46. QUALITY SOFTWARE
=
SLEEP WELL AFTER PUSHING NEW
CODE TO MILLIONS OF USERS

47. QUALITY SOFTWARE
t
code complexity
dev velocity
issues

48. benji@makeschool.com
THANK YOU!