HTML reports publishing in Jenkins - Practice Problems & Coding Challenges

Challenge - 5 Problems

💻 Command Output

intermediate

Jenkins HTML Publisher Plugin Basic Usage

You have configured the Jenkins HTML Publisher plugin to publish reports from the directory target/reports with the report name Test Report. After a successful build, what will be the URL path to access this report in Jenkins?

A /job/<job-name>/lastSuccessfulBuild/htmlreports/Test%20Report/index.html

B /job/<job-name>/lastSuccessfulBuild/htmlreports/Test Report/index.html

C /job/<job-name>/lastSuccessfulBuild/htmlreports/Test_Report/index.html

D /job/<job-name>/lastSuccessfulBuild/artifact/target/reports/index.html

💡 Hint

Spaces in report names are encoded in URLs.

The HTML Publisher plugin encodes spaces as %20 in URLs. The report is accessible under the htmlreports path with the report name as folder, so spaces become %20.

❓ Configuration

intermediate

Correct Jenkins Pipeline Syntax for HTML Report Publishing

Which Jenkins pipeline snippet correctly publishes HTML reports located in build/reports with the report name Coverage Report?

A publishHTML([allowMissing: false, alwaysLinkToLastBuild: true, keepAll: true, reportDir: 'build/reports', reportFiles: 'index.html', reportName: 'Coverage Report'])

B publishHTML(reportDir: 'build/reports', reportFiles: 'index.html', reportName: 'Coverage Report')

C publishHTML([reportDir: 'build/reports', reportFiles: 'index.html', reportName: 'Coverage Report'])

D publishHTML('build/reports', 'index.html', 'Coverage Report')

💡 Hint

The publishHTML step requires a map inside a list with specific keys.

The publishHTML step expects a list of maps with keys like reportDir, reportFiles, reportName, and optional flags. Option A correctly uses this syntax.

❓ Troubleshoot

advanced

Troubleshooting Missing HTML Reports in Jenkins

After configuring the HTML Publisher plugin, the reports do not appear in Jenkins UI. Which of the following is the most likely cause?

A The Jenkins user does not have permission to access the Jenkins UI.

B The Jenkins server is missing the HTML Publisher plugin installation.

C The reportFiles parameter is set to a file that is not an HTML file.

D The report directory path is incorrect or does not exist at build time.

💡 Hint

Check the build workspace for the report directory existence.

If the report directory does not exist or is empty at the time of publishing, the reports will not show. Permissions or plugin absence would cause different errors.

🔀 Workflow

advanced

Order of Steps to Publish HTML Reports in Jenkins Pipeline

Arrange the following Jenkins pipeline steps in the correct order to generate and publish HTML reports:

A 1,2,3,4

B 1,3,2,4

C 3,1,2,4

D 3,2,1,4

💡 Hint

Source code must be checked out before tests run.

First checkout code (3), then run tests to generate reports (1), then publish reports (2), and optionally archive artifacts (4).

✅ Best Practice

expert

Best Practice for Handling Spaces in HTML Report Names in Jenkins

You want to publish multiple HTML reports with names containing spaces, such as Test Report and Coverage Report. What is the best practice to avoid URL and access issues?

A Use spaces as is; Jenkins automatically handles encoding.

B Replace spaces with underscores in report names before publishing.

C Use only lowercase letters and no spaces in report names.

D Publish reports without specifying report names to avoid spaces.

💡 Hint

Spaces in URLs can cause encoding issues.

Replacing spaces with underscores avoids URL encoding problems and makes URLs cleaner and easier to access.

Practice

1. What is the main purpose of publishing HTML reports in Jenkins?

easy

A. To display test and build results inside Jenkins in a readable format

B. To execute shell commands during the build

C. To send email notifications after a build

D. To create new Jenkins jobs automatically

Solution

1. Step 1: Understand the role of HTML reports in Jenkins

   HTML reports are used to show test and build results in a user-friendly way inside Jenkins.

2. Step 2: Identify the correct purpose

   Among the options, only displaying results inside Jenkins matches the purpose of HTML reports.

3. Final Answer:

   To display test and build results inside Jenkins in a readable format -> Option A

4. Quick Check:

   HTML reports = readable results inside Jenkins [OK]

Hint: HTML reports show results inside Jenkins UI [OK]

Common Mistakes:

• Confusing HTML reports with build execution steps
• Thinking HTML reports send notifications
• Assuming HTML reports create jobs

2. Which of the following is the correct syntax to publish an HTML report in a Jenkins pipeline script?

easy

A. publishHTML { reportDir: 'reports', reportFiles: 'index.html', reportName: 'My Report' }

B. publishHTML(reportDir: 'reports', reportFiles: 'index.html', reportName: 'My Report')

C. publishHTML('reports', 'index.html', 'My Report')

D. publishHTML(target: [allowMissing: false, alwaysLinkToLastBuild: true, keepAll: true, reportDir: 'reports', reportFiles: 'index.html', reportName: 'My Report'])

Solution

1. Step 1: Review the correct Jenkins pipeline syntax for publishHTML

   The publishHTML step requires a target map with keys like allowMissing, alwaysLinkToLastBuild, keepAll, reportDir, reportFiles, and reportName.

2. Step 2: Compare options to syntax

   publishHTML(target: [allowMissing: false, alwaysLinkToLastBuild: true, keepAll: true, reportDir: 'reports', reportFiles: 'index.html', reportName: 'My Report']) correctly uses the target map with all required keys and proper syntax.

3. Final Answer:

   publishHTML(target: [allowMissing: false, alwaysLinkToLastBuild: true, keepAll: true, reportDir: 'reports', reportFiles: 'index.html', reportName: 'My Report']) -> Option D

4. Quick Check:

   publishHTML uses target map syntax [OK]

Hint: Use publishHTML with target map and keys [OK]

Common Mistakes:

• Omitting the target keyword
• Passing parameters as separate arguments
• Using curly braces instead of parentheses

3. Given this Jenkins pipeline snippet:

publishHTML(target: [allowMissing: true, keepAll: false, reportDir: 'test-results', reportFiles: 'summary.html', reportName: 'Test Summary'])

What happens if the 'summary.html' file is missing after the build?

medium

A. The build will fail due to missing report file

B. The build will succeed and no report will be shown

C. Jenkins will create an empty report automatically

D. The build will pause and wait for the file

Solution

1. Step 1: Understand the allowMissing option

   allowMissing: true means Jenkins will not fail the build if the report file is missing.

2. Step 2: Predict behavior when file is missing

   Since allowMissing is true, the build succeeds but no report is shown.

3. Final Answer:

   The build will succeed and no report will be shown -> Option B

4. Quick Check:

   allowMissing true = no failure if missing [OK]

Hint: allowMissing true lets build pass without report [OK]

Common Mistakes:

• Assuming build fails when allowMissing is true
• Thinking Jenkins creates missing files
• Believing build pauses for missing files

4. You configured publishHTML in your Jenkins pipeline but the HTML report does not appear in the build results. Which of these is the most likely cause?

medium

A. The Jenkins server needs a restart

B. The publishHTML step is missing the allowMissing option

C. The reportDir path is incorrect or does not contain the report files

D. The reportName is too long

Solution

1. Step 1: Check common reasons for missing HTML reports

   If the reportDir path is wrong or empty, Jenkins cannot find the report files to display.

2. Step 2: Evaluate other options

   allowMissing missing does not prevent report display if files exist; reportName length and server restart are unrelated.

3. Final Answer:

   The reportDir path is incorrect or does not contain the report files -> Option C

4. Quick Check:

   Wrong reportDir = no report shown [OK]

Hint: Verify reportDir path and files exist [OK]

Common Mistakes:

• Ignoring reportDir correctness
• Thinking allowMissing affects report visibility
• Restarting Jenkins unnecessarily

5. You want Jenkins to keep all HTML reports from every build and always link to the latest report. Which configuration achieves this?

hard

A. publishHTML(target: [keepAll: true, alwaysLinkToLastBuild: true, reportDir: 'output', reportFiles: 'report.html', reportName: 'Build Report'])

B. publishHTML(target: [keepAll: false, alwaysLinkToLastBuild: false, reportDir: 'output', reportFiles: 'report.html', reportName: 'Build Report'])

C. publishHTML(target: [keepAll: true, alwaysLinkToLastBuild: false, reportDir: 'output', reportFiles: 'report.html', reportName: 'Build Report'])

D. publishHTML(target: [keepAll: false, alwaysLinkToLastBuild: true, reportDir: 'output', reportFiles: 'report.html', reportName: 'Build Report'])

Solution

1. Step 1: Understand keepAll and alwaysLinkToLastBuild options

   keepAll: true keeps reports from all builds. alwaysLinkToLastBuild: true creates a link to the latest report.

2. Step 2: Match options to requirement

   publishHTML(target: [keepAll: true, alwaysLinkToLastBuild: true, reportDir: 'output', reportFiles: 'report.html', reportName: 'Build Report']) sets both keepAll and alwaysLinkToLastBuild to true, meeting the requirement.

3. Final Answer:

   publishHTML(target: [keepAll: true, alwaysLinkToLastBuild: true, reportDir: 'output', reportFiles: 'report.html', reportName: 'Build Report']) -> Option A

4. Quick Check:

   keepAll and alwaysLinkToLastBuild true = keep all and link latest [OK]

Hint: Set keepAll and alwaysLinkToLastBuild to true [OK]

Common Mistakes:

• Setting keepAll false loses old reports
• Not linking to last build report
• Confusing option names