Static analysis tools in Testing Fundamentals - Framework Patterns

Framework Mode - Static analysis tools

Folder Structure for Static Analysis Setup

static-analysis-project/
├── src/
│   ├── main_code/          # Your application source code
│   └── tests/              # Automated tests
├── tools/                  # Static analysis tool configs and scripts
│   ├── linters/            # Linter configs (e.g., ESLint, Pylint)
│   ├── formatters/         # Code format configs (e.g., Prettier)
│   └── security/           # Security static analysis configs (e.g., Bandit)
├── reports/                # Generated static analysis reports
├── .gitignore              # Ignore files
├── README.md               # Project overview
└── ci/                     # CI pipeline configs integrating static analysis
  

Static Analysis Framework Layers

• Source Code Layer: Your application code to be analyzed.
• Tool Configuration Layer: Settings for linters, formatters, and security scanners.
• Execution Layer: Scripts or commands that run the static analysis tools.
• Reporting Layer: Collects and formats the results for review.
• Integration Layer: Connects static analysis with CI/CD pipelines for automated checks.

Configuration Patterns for Static Analysis

• Environment-specific configs: Use separate config files or overrides for dev, test, and production environments.
• Tool-specific config files: Place configs like .eslintrc.json, .pylintrc, or bandit.yml in the tools/ folder.
• Ignore rules: Define files or patterns to exclude from analysis (e.g., generated code).
• Credential safety: Never store secrets in configs; use environment variables or secure vaults.
• Version control: Track config files in source control for consistency across teams.

Test Reporting and CI/CD Integration

• Report formats: Generate human-readable reports (HTML, JSON) for easy review.
• Fail builds on issues: Configure CI pipelines to fail if static analysis finds critical problems.
• Notifications: Send alerts or comments on pull requests with static analysis results.
• Trend tracking: Store reports over time to monitor code quality improvements or regressions.
• Tool integration: Use CI tools like GitHub Actions, Jenkins, or GitLab CI to automate static analysis runs.

Best Practices for Static Analysis Frameworks

1. Automate analysis: Run static analysis automatically on every code change to catch issues early.
2. Keep configs simple: Start with basic rules and gradually add complexity to avoid overwhelming developers.
3. Integrate with developer tools: Enable IDE plugins or pre-commit hooks for immediate feedback.
4. Prioritize issues: Focus on critical and high-impact problems first to improve code quality effectively.
5. Review and update regularly: Keep tool versions and rules up to date to catch new types of issues.

Self-Check Question

Where in this folder structure would you add a new configuration file for a security static analysis tool like Bandit?

Key Result

Organize static analysis tools and configs separately, automate runs in CI, and report issues clearly to improve code quality.

Practice

1. What is the main purpose of static analysis tools in software testing?

easy

A. To deploy the software to production

B. To execute the program and check its output

C. To test the user interface manually

D. To find errors in code without running the program

Solution

1. Step 1: Understand static analysis tools

   Static analysis tools examine code by reading it, not by running it.

2. Step 2: Compare options

   Only To find errors in code without running the program describes checking code without execution, which is the main purpose.

3. Final Answer:

   To find errors in code without running the program -> Option D

4. Quick Check:

   Static analysis = code check without run [OK]

Hint: Static analysis checks code without running it [OK]

Common Mistakes:

• Confusing static analysis with dynamic testing
• Thinking static analysis runs the program
• Mixing up manual UI testing with static analysis

2. Which of the following is a correct example of a static analysis tool?

easy

A. Selenium

B. ESLint

C. JUnit

D. Postman

Solution

1. Step 1: Identify static analysis tools

   ESLint is a tool that checks JavaScript code for errors and style issues without running it.

2. Step 2: Eliminate other options

   Selenium is for UI testing, JUnit is for unit testing (dynamic), Postman is for API testing.

3. Final Answer:

   ESLint -> Option B

4. Quick Check:

   ESLint = static analysis tool [OK]

Hint: ESLint is a popular static analysis tool for JavaScript [OK]

Common Mistakes:

• Choosing Selenium which is for dynamic UI testing
• Confusing JUnit with static analysis
• Selecting Postman which tests APIs dynamically

3. Consider this Python code snippet checked by a static analysis tool:

def add(a, b):
    return a + b

result = add(5, '3')

What issue will the static analysis tool most likely report?

medium

A. Type mismatch: adding int and str

B. Syntax error due to missing colon

C. Unused variable 'result'

D. No issues found

Solution

1. Step 1: Analyze the code for type errors

   The function adds two parameters. The call adds an integer 5 and a string '3', which is a type mismatch.

2. Step 2: Understand static analysis detection

   Static analysis tools detect type mismatches like adding int and str without running the code.

3. Final Answer:

   Type mismatch: adding int and str -> Option A

4. Quick Check:

   Static analysis finds type errors like int + str [OK]

Hint: Look for type mismatches in function calls [OK]

Common Mistakes:

• Thinking missing colon causes error (it is present)
• Ignoring type mismatch between int and string
• Assuming variable 'result' is unused error

4. A static analysis tool reports a warning: "Unused variable 'temp'" in this code:

def calculate(x):
    temp = x * 2
    return x + 1

What is the best fix?

medium

A. Add a print statement for 'temp' to use it

B. Rename 'temp' to 'result' to fix the warning

C. Remove the variable 'temp' since it is not used

D. Ignore the warning; it does not affect the code

Solution

1. Step 1: Understand the warning

   The variable 'temp' is assigned but never used, which wastes memory and may confuse readers.

2. Step 2: Choose the best fix

   Removing 'temp' cleans the code and resolves the warning. Renaming or printing does not solve the root cause.

3. Final Answer:

   Remove the variable 'temp' since it is not used -> Option C

4. Quick Check:

   Unused variables should be removed [OK]

Hint: Remove variables that are assigned but never used [OK]

Common Mistakes:

• Renaming variable without using it
• Adding print statements unnecessarily
• Ignoring warnings thinking they are harmless

5. You want to use a static analysis tool to improve code quality before testing. Which approach is best?

hard

A. Integrate static analysis into the development process early

B. Run static analysis only on production code

C. Use static analysis only for UI code

D. Run static analysis after all tests pass

Solution

1. Step 1: Understand when to use static analysis

   Static analysis is most effective when used early during development to catch errors before testing.

2. Step 2: Evaluate options

   Integrate static analysis into the development process early suggests integrating static analysis early, which improves code quality and reduces bugs later.

3. Final Answer:

   Integrate static analysis into the development process early -> Option A

4. Quick Check:

   Early static analysis improves code quality [OK]

Hint: Use static analysis early in development [OK]

Common Mistakes:

• Running static analysis only after tests
• Limiting static analysis to production code
• Applying static analysis only to UI code