Manual testing to automatic testing A formal training programme for testers at Bands 3 to 7

4.3.1 Explain Which Factors Support and Affect Test Automation Solution Maintainability

Part of 4 Implementing Test Automation, 4.3 Test Automation Solution Maintainability.

Learning objective: TAE-4.3.1 (K2).

In short

Test code stays maintainable when it follows clean code principles, avoids hard-coded values, uses design patterns well, is checked by static analysers, and lives in a sensible branching strategy.

Key ideas

Clean code principles (from Robert C. Martin's Clean Code):

  • meaningful, consistent names for classes, methods, and variables, such as loginButton or resetPasswordButton
  • a logical, common project structure
  • no hard-coding
  • few input parameters per method
  • short, simple methods
  • logging
  • design patterns where they help
  • a focus on testability.

Avoid hard-coding. Embedded values are quick to write and slow to maintain. Use data-driven testing for test data, and named constants for values that rarely change.

Use tools. Static analysers find quality problems; code formatters improve readability.

Use version control well: an agreed branching strategy, with branches for features, releases, and fixes.

In this programme

The practice repository runs ESLint and Prettier in CI (Module 13), reads the FHIR server's address from FHIR_BASE_URL, with a local default, instead of writing URLs into tests, and asks for small pull requests on feature branches (Module 9 Version control and collaboration).

Teach it (30 minutes)

Show a deliberately messy 40-line test with hard-coded values, vague names, and one long function. In pairs, list every clean code principle it breaks, then refactor one part.

Check yourself

  1. Name five clean code principles.
  2. How can you avoid hard-coding test data?
  3. How does a branching strategy help maintainability?

Previous: 4.3 Test Automation Solution Maintainability · Contents · Next: 5 Implementation and Deployment Strategies for Test Automation

Based on the ISTQB Certified Tester Advanced Level Test Automation Engineering (CTAL-TAE) syllabus, version 2.0, section 4.3.1. The syllabus is © International Software Testing Qualifications Board (ISTQB®); ISTQB® is a registered trademark of the ISTQB. Copyright © 2024 the authors of the syllabus: Andrew Pollner (Chair), Péter Földházi, Patrick Quilter, Gergely Ágnecz, and László Szikszai. This page explains its concepts in our own words, for teaching, and is not an accredited course or a substitute for the syllabus.

View this document on GitHub materials/modules/module-5-istqb-certified-tester-advanced-level-test-automation-engineer/syllabus/4-3-1-explain-which-factors-support-and-affect-test-automation-solution-maintainability.md