Skip to content

Commit c1ec5c5

Browse files
anteloro-boehanteloro-boeh
committed
chore: merge with master
2 parents c760824 + 2525e1e commit c1ec5c5

6 files changed

Lines changed: 21 additions & 131 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
# Changelog
22

33
## Unreleased
4-
- Make risk level column in Overview of Unit Tested Modules (in DTP and DTR) wrappable ([#144](https://github.com/opendevstack/ods-document-generation-templates/pull/144))
4+
- Remove Jira issue ID strikethrough on SLC documents. ([#153](https://github.com/opendevstack/ods-document-generation-templates/pull/153))
5+
- Make content in column Test Case No. wrappable. ([#152](https://github.com/opendevstack/ods-document-generation-templates/pull/152))
56
- TIR changes: Wording changes to be more inclusive of helm deployments, removed dynamic values from report tables and change in table formatting ([#146](https://github.com/opendevstack/ods-document-generation-templates/pull/146))
67

8+
## 1.2.10 - 2025-1-27
9+
- Remove "Initials/Date" from TCP and TCR documents. ([#150](https://github.com/opendevstack/ods-document-generation-templates/pull/150))
10+
- Update TRC reference document with SSDS and TCP ([#149](https://github.com/opendevstack/ods-document-generation-templates/pull/149))
11+
712
## 1.2.9 - 2024-08-26
813
- Make risk level column in Overview of Unit Tested Modules (in DTP and DTR) wrappable ([#144](https://github.com/opendevstack/ods-document-generation-templates/pull/144))
914
- Fix CSD file with block containing N/A always present ([#147](https://github.com/opendevstack/ods-document-generation-templates/pull/147))

‎css/styles.css‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ h5 span {
4747
margin-right: 1.5em;
4848
}
4949

50+
del {
51+
text-decoration: none;
52+
}
5053

5154
input + label {
5255
margin-left: 0.5em;

‎templates/DIL.html.tmpl‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@
8282
<table>
8383
<thead>
8484
<th style="white-space: nowrap">Discrepancy ID</th>
85-
<th style="white-space: nowrap">Test Case No.</th>
85+
<th class="content-wrappable">Test Case No.</th>
8686
<th class="content-wrappable">Level of Test Case</th>
8787
<th class="content-wrappable">Description of Failure or Discrepancy</th>
8888
<th class="content-wrappable">Remediation Action</th>
@@ -94,7 +94,7 @@
9494
{{#each data.integrationTests}}
9595
<tr>
9696
<td style="white-space: nowrap">{{discrepancyID}}</td>
97-
<td style="white-space: nowrap">{{testcaseID}}</td>
97+
<td class="content-wrappable">{{testcaseID}}</td>
9898
<td class="content-wrappable">Integration</td>
9999
<td class="hyphenate">{{{description}}}</td>
100100
<td class="content-wrappable">{{{remediation}}}</td>
@@ -122,7 +122,7 @@
122122
<table>
123123
<thead>
124124
<th style="white-space: nowrap">Discrepancy ID</th>
125-
<th style="white-space: nowrap">Test Case No.</th>
125+
<th class="content-wrappable">Test Case No.</th>
126126
<th class="content-wrappable">Level of Test Case</th>
127127
<th class="content-wrappable">Description of Failure or Discrepancy</th>
128128
<th class="content-wrappable">Remediation Action</th>
@@ -134,7 +134,7 @@
134134
{{#each data.acceptanceTests}}
135135
<tr>
136136
<td style="white-space: nowrap">{{discrepancyID}}</td>
137-
<td style="white-space: nowrap">{{testcaseID}}</td>
137+
<td class="content-wrappable">{{testcaseID}}</td>
138138
<td class="content-wrappable">Acceptance</td>
139139
<td class="hyphenate">{{{description}}}</td>
140140
<td class="content-wrappable">{{{remediation}}}</td>

‎templates/TCP.html.tmpl‎

Lines changed: 0 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -159,63 +159,6 @@
159159
</ul>
160160
</div>
161161

162-
<!--
163-
<div class="page">
164-
<h2 id="section_3"><span>3</span>Scope of Test Execution</h2>
165-
<p>This section will be manually filled before test execution. Please describe the scope of Test case execution in case not all test cases in this document will be executed.</p>
166-
{{#if data.sections.sec3.show}}
167-
<table style="border: 0px; padding: 0px; margin: 0px">
168-
<tr>
169-
<td class="content-wrappable" style="border: 0px; padding: 0px; margin: 0px;">{{{data.sections.sec3.content}}}</td>
170-
</tr>
171-
</table>
172-
{{else}}
173-
<p>Not mandatory</p>
174-
{{/if}}
175-
</div>
176-
177-
<div class="page">
178-
<h2 id="section_4"><span>4</span>Test Execution Instructions</h2>
179-
<p>In the case that the test execution is fully automated, Jenkins (Technical Role) shall:</p>
180-
<ul>
181-
<li>Execute the code base test cases</li>
182-
<li>Record the test results and evidence after the execution and include them in the XUnit file</li>
183-
<li>Following Good Documentation Practices</li>
184-
<li>Mark the test cases as a "Fail" or a "Pass"</li>
185-
<li>Stop the test execution if one of the test cases has failed</li>
186-
<li>Report back the test execution results to the Test Management Tool</li>
187-
</ul>
188-
189-
<p>Preparation of the test document for execution:</p>
190-
<ul>
191-
<li>Test results must be documented on a paper copy or a printout of the approved test case document.</li>
192-
<li>The copy or printout must include the approval signatures (handwritten or electronic signature page) for the test cases</li>
193-
<li>Pages of test cases that will not be executed may be removed prior to start of test execution. This must be documented in section 3.</li>
194-
<li>No pages of the copy or printout must be removed or replaced during test execution.</li>
195-
<li>Pages may be added during execution, e.g. if test cases need to be re-executed. Reason for the addition must be documented on these additional pages.</li>
196-
</ul>
197-
<p>For the documentation of test results the following rules of good documentation practice need to be fulfilled:</p>
198-
<ul>
199-
<li>Results and other entries have to be recorded handwritten.</li>
200-
<li>Initials, signatures and dates provided by the tester have to be documented handwritten.</li>
201-
<li>Handwritten entries must be made in clear, legible, indelible way.</li>
202-
<li>Records must be made or completed at the time each action is taken and in such a way that all significant activities are traceable.</li>
203-
<li>Any alteration made to an entry must be signed and dated; the alteration should permit the reading of the original information. Where appropriate, the reason for the alteration should be recorded.</li>
204-
</ul>
205-
<p>Creation of supporting evidence:</p>
206-
<ul>
207-
<li>Supporting evidence must be printed, dated and signed by the Tester, and labelled with test case # and step # on the day of test execution.</li>
208-
<li>Screen shots or other objective evidence made by one tester may be collected e.g. in a MS Word document, but must be printed and dated/signed by the Tester on the day of test execution. Alternatively, these can be signed in IDEAforCON directly, as long as the Tester signs the Word document with the screenshots on the day of test execution in IDEAforCON.</li>
209-
<li>In case of electronically recorded evidence (e.g. video files), the test results must be unambiguously linked to the objective evidence, summarized on a printout and signed on the day of test execution.</li>
210-
</ul>
211-
<p>The column "Initials / Date" only needs to be filled if</p>
212-
<ul>
213-
<li>Test steps in a test case are executed by more than one tester: Each tester writes initials/dates for all steps executed into the column.</li>
214-
<li>Test steps in a test case are executed on more than one day: the tester writes the date of execution for every step into the column.</li>
215-
</ul>
216-
</div>
217-
-->
218-
219162
<div class="page">
220163
<h2 id="section_3"><span>3</span>Test Cases</h2>
221164
<h3 id="section_3_1"><span>3.1</span>Integration Test Cases</h3>
@@ -250,7 +193,6 @@
250193
<th>Instructions</th>
251194
<th>Expected result</th>
252195
<th>Actual result</th>
253-
<th>Initials / Date</th>
254196
</thead>
255197
<tbody>
256198
{{#each steps}}
@@ -259,7 +201,6 @@
259201
<td class="content-wrappable">{{{step}}}</td>
260202
<td class="content-wrappable">{{{result}}}</td>
261203
<td class="content-wrappable">{{{actualResult}}}</td>
262-
<td></td>
263204
</tr>
264205
{{/each}} <!-- end test steps -->
265206
</tbody>
@@ -322,7 +263,6 @@
322263
<th>Instructions</th>
323264
<th>Expected result / Evidence</th>
324265
<th>Actual result</th>
325-
<th>Initials / Date</th>
326266
</thead>
327267
<tbody>
328268
{{#each steps}}
@@ -331,7 +271,6 @@
331271
<td class="content-wrappable">{{{step}}}</td>
332272
<td class="content-wrappable">{{{result}}}</td>
333273
<td>{{{../actualResult}}}</td>
334-
<td></td>
335274
</tr>
336275
{{/each}} <!-- end test steps block -->
337276
</tbody>

‎templates/TCR.html.tmpl‎

Lines changed: 0 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -168,63 +168,6 @@
168168
</ul>
169169
</div>
170170

171-
<!--
172-
<div class="page">
173-
<h2 id="section_3"><span>3</span>Scope of Test Execution</h2>
174-
<p>This section will be manually filled before test execution. Please describe the scope of Test case execution in case not all test cases in this document will be executed.</p>
175-
{{#if data.sections.sec3.show}}
176-
<table style="border: 0px; padding: 0px; margin: 0px">
177-
<tr>
178-
<td class="content-wrappable" style="border: 0px; padding: 0px; margin: 0px;">{{{data.sections.sec3.content}}}</td>
179-
</tr>
180-
</table>
181-
{{else}}
182-
<p>Not mandatory</p>
183-
{{/if}}
184-
</div>
185-
186-
<div class="page">
187-
<h2 id="section_4"><span>4</span>Test Execution Instructions</h2>
188-
<p>In the case that the test execution is fully automated, Jenkins (Technical Role) shall:</p>
189-
<ul>
190-
<li>Execute the code base test cases</li>
191-
<li>Record the test results and evidence after the execution and include them in the XUnit file</li>
192-
<li>Following Good Documentation Practices</li>
193-
<li>Mark the test cases as a "Fail" or a "Pass"</li>
194-
<li>Stop the test execution if one of the test cases has failed</li>
195-
<li>Report back the test execution results to the Test Management Tool</li>
196-
</ul>
197-
198-
<p>Preparation of the test document for execution:</p>
199-
<ul>
200-
<li>Test results must be documented on a paper copy or a printout of the approved test case document.</li>
201-
<li>The copy or printout must include the approval signatures (handwritten or electronic signature page) for the test cases</li>
202-
<li>Pages of test cases that will not be executed may be removed prior to start of test execution. This must be documented in section 3.</li>
203-
<li>No pages of the copy or printout must be removed or replaced during test execution.</li>
204-
<li>Pages may be added during execution, e.g. if test cases need to be re-executed. Reason for the addition must be documented on these additional pages.</li>
205-
</ul>
206-
<p>For the documentation of test results the following rules of good documentation practice need to be fulfilled:</p>
207-
<ul>
208-
<li>Results and other entries have to be recorded handwritten.</li>
209-
<li>Initials, signatures and dates provided by the tester have to be documented handwritten.</li>
210-
<li>Handwritten entries must be made in clear, legible, indelible way.</li>
211-
<li>Records must be made or completed at the time each action is taken and in such a way that all significant activities are traceable.</li>
212-
<li>Any alteration made to an entry must be signed and dated; the alteration should permit the reading of the original information. Where appropriate, the reason for the alteration should be recorded.</li>
213-
</ul>
214-
<p>Creation of supporting evidence:</p>
215-
<ul>
216-
<li>Supporting evidence must be printed, dated and signed by the Tester, and labelled with test case # and step # on the day of test execution.</li>
217-
<li>Screen shots or other objective evidence made by one tester may be collected e.g. in a MS Word document, but must be printed and dated/signed by the Tester on the day of test execution. Alternatively, these can be signed in IDEAforCON directly, as long as the Tester signs the Word document with the screenshots on the day of test execution in IDEAforCON.</li>
218-
<li>In case of electronically recorded evidence (e.g. video files), the test results must be unambiguously linked to the objective evidence, summarized on a printout and signed on the day of test execution.</li>
219-
</ul>
220-
<p>The column "Initials / Date" only needs to be filled if</p>
221-
<ul>
222-
<li>Test steps in a test case are executed by more than one tester: Each tester writes initials/dates for all steps executed into the column.</li>
223-
<li>Test steps in a test case are executed on more than one day: the tester writes the date of execution for every step into the column.</li>
224-
</ul>
225-
</div>
226-
-->
227-
228171
<div class="page">
229172
<h2 id="section_3"><span>3</span>Test Cases</h2>
230173
<h3 id="section_3_1"><span>3.1</span>Integration Test Cases</h3>
@@ -259,7 +202,6 @@
259202
<th>Instructions</th>
260203
<th>Expected result</th>
261204
<th>Actual result</th>
262-
<th>Initials / Date</th>
263205
</thead>
264206
<tbody>
265207
{{#each steps}}
@@ -268,7 +210,6 @@
268210
<td class="content-wrappable">{{{step}}}</td>
269211
<td class="content-wrappable">{{{result}}}</td>
270212
<td class="content-wrappable">{{{../actualResult}}}</td>
271-
<td class="content-wrappable">Jenkins {{{../timestamp}}}</td>
272213
</tr>
273214
{{/each}} <!-- end test steps -->
274215
</tbody>
@@ -331,7 +272,6 @@
331272
<th>Instructions</th>
332273
<th>Expected result / Evidence</th>
333274
<th>Actual result</th>
334-
<th>Initials / Date</th>
335275
</thead>
336276
<tbody>
337277
{{#each steps}}
@@ -340,7 +280,6 @@
340280
<td class="content-wrappable">{{{step}}}</td>
341281
<td class="content-wrappable">{{{result}}}</td>
342282
<td class="content-wrappable">{{{actualResult}}}</td>
343-
<td>Jenkins {{{../timestamp}}}</td>
344283
</tr>
345284
{{/each}} <!-- end test steps block -->
346285
</tbody>

‎templates/TRC.html.tmpl‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,14 @@
9898
<td class="content-wrappable">Risk Assessment</td>
9999
<td class="lean">{{metadata.referencedDocs.RA}}</td>
100100
</tr>
101-
<tr>
102-
<td class="content-wrappable">Combined Functional and Requirements Testing Plan</td>
103-
<td class="lean">{{metadata.referencedDocs.CFTP}}</td>
104-
</tr>
101+
<tr>
102+
<td class="content-wrappable">System and Software Design Specification incl. Source Code Review Plan</td>
103+
<td class="lean">{{metadata.referencedDocs.SSDS}}</td>
104+
</tr>
105+
<tr>
106+
<td class="content-wrappable">Test Cases Plan</td>
107+
<td class="lean">{{metadata.referencedDocs.TCP}}</td>
108+
</tr>
105109
</tbody>
106110
</table>
107111
</div>

0 commit comments

Comments
 (0)