HTML reports publishing in Jenkins - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to publish HTML reports in Jenkins pipeline.

Jenkins

publishHTML(target: [allowMissing: false, alwaysLinkToLastBuild: true, keepAll: true, reportDir: 'reports', reportFiles: '[1]', reportName: 'Test Report'])

Drag options to blanks, or click blank then click option'

Areport.txt

Bindex.html

Coutput.log

Dsummary.md

Attempts:

3 left

💡 Hint

Common Mistakes

Using a non-HTML file like .txt or .log as the report file.

Leaving the reportFiles parameter empty.

The reportFiles parameter should point to the main HTML file, usually index.html, to publish the report correctly.

2fill in blank

medium

Complete the code to specify the directory containing the HTML reports.

Jenkins

publishHTML(target: [reportDir: '[1]', reportFiles: 'index.html', reportName: 'Coverage Report'])

Drag options to blanks, or click blank then click option'

Acoverage

Bbuild

Clogs

Dsrc

Attempts:

3 left

💡 Hint

Common Mistakes

Using a directory that does not contain the HTML files.

Confusing source code folders with report folders.

The reportDir should point to the folder where the HTML reports are generated, commonly named coverage for coverage reports.

3fill in blank

hard

Fix the error in the Jenkins pipeline snippet to correctly publish HTML reports.

Jenkins

publishHTML(target: [allowMissing: false, alwaysLinkToLastBuild: true, keepAll: true, reportDir: 'test-results', reportFiles: '[1]', reportName: 'Test Results'])

Drag options to blanks, or click blank then click option'

Aresults.html

Btest-results.html

Creport.xml

Dindex.html

Attempts:

3 left

💡 Hint

Common Mistakes

Using XML or non-HTML files as reportFiles.

Mismatching the reportFiles name with actual file in directory.

The reportFiles must be an HTML file, typically index.html. Using a non-HTML or incorrectly named file causes the report not to display.

4fill in blank

hard

Fill both blanks to configure Jenkins to keep all reports and link to the last build.

Jenkins

publishHTML(target: [keepAll: [1], alwaysLinkToLastBuild: [2], reportDir: 'output', reportFiles: 'index.html', reportName: 'Build Report'])

Drag options to blanks, or click blank then click option'

Atrue

Bfalse

Cyes

Dno

Attempts:

3 left

💡 Hint

Common Mistakes

Using strings like 'yes' or 'no' instead of boolean true/false.

Setting these options to false disables report retention or linking.

Both keepAll and alwaysLinkToLastBuild expect boolean values. Setting them to true ensures all reports are kept and the last build is linked.

5fill in blank

hard

Fill all three blanks to create a Jenkins pipeline snippet that publishes HTML reports with custom report directory, file, and name.

Jenkins

publishHTML(target: [reportDir: '[1]', reportFiles: '[2]', reportName: '[3]'])

Drag options to blanks, or click blank then click option'

Atest-results

Bindex.html

CFunctional Tests

Dlogs

Attempts:

3 left

💡 Hint

Common Mistakes

Mixing up directory and file names.

Using generic or unclear report names.

The reportDir is set to test-results, the reportFiles to index.html, and the reportName to a descriptive name like Functional Tests.

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