docs: add Test Starter #65

maxreichmann · 2024-10-30T14:03:03Z

Dev Guide explaining Test Starter: https://ui5.sap.com/#/topic/032be2cb2e1d4115af20862673bedcdb

JIRA: CPOUI5FOUNDATION-819

margopolo

Are there indeed no additional resources (e.g. chapters in the documentation) about the test starter?

In general, I believe there is still some explanation needed so beginners can understand and extrapolate from the tutorial to their use cases.

In addition, the link for previewing this step on the github page is not adapted also file test/unit/unitTests-cdn.qunit.html was deleted. I would assume that two additional files (testsuite-cdn.qunit.html and Test-cdn.qunit.hmtl) are still needed to compliment this step.
Also, in the readme we would need a new image (or rather link) for the folder structure, as the current one does not fit anymore.

steps/27/README.md

margopolo · 2024-10-31T09:47:16Z

What is the minimum OpenUI5 version required for the test starter?
We currently require version 1.129. If a higher version is necessary, all steps in this tutorial will need to be updated to match the new version.

maxreichmann · 2024-10-31T15:46:07Z

Are there indeed no additional resources (e.g. chapters in the documentation) about the test starter?

In general, I believe there is still some explanation needed so beginners can understand and extrapolate from the tutorial to their use cases.

In addition, the link for previewing this step on the github page is not adapted also file test/unit/unitTests-cdn.qunit.html was deleted. I would assume that two additional files (testsuite-cdn.qunit.html and Test-cdn.qunit.hmtl) are still needed to compliment this step. Also, in the readme we would need a new image (or rather link) for the folder structure, as the current one does not fit anymore.

Regarding additional resources, these Dev Guide chapters could be helpful (and is linked in Step 27)

Regarding the link for previewing this step on the github page: I don't fully understand. How exactly does this preview work? The README.me file can at least be viewed as the compiled markdown code locally.

Regarding the deletion of the two cdn files. I assumed these two files are not necessary anymore with the introduction of the Test Starter.

A new image of the new folder structure is indeed necessary and will be added by UA colleagues.

codeworrior · 2024-11-07T09:33:12Z

@margopolo AFAIK, minimal version for using it in apps is 1.124.

* test: add CDN testsuite files * refactor: remove whitespace from legacy HelloDialogFragment.xml + mockserver.html

`animationMode: minimal` is not required and not setting it simplifies the config.

matz3 · 2024-11-07T15:31:16Z

Now it's ready for review. We'll update the other steps once the content is approved to keep the changes for review as small as possible. Only steps 27 and 28 make changes in the test folder, so it can just be overwritten.

steps/27/webapp/test/Test.cdn.qunit.html

flovogt

@LilyanaOviPe could please have a look

matz3 · 2024-11-11T12:30:52Z

steps/27/README.md


 ### Conventions

 -   All unit tests are placed in the webapp/test/unit folder of the app.

-   Files in the test suite end with `*.qunit.html`.


Add testsuite naming convention (testsuite.*.qunit.js)

margopolo · 2024-11-11T13:47:08Z

steps/27/README.md

@@ -82,34 +85,33 @@ QUnit.test("Should return the translated texts", (assert) => {
 ### webapp/test/unit/unitTests.qunit.ts \(New\)

 We create a new `unitTests.qunit.ts` file under `webapp/test/unit/`.
-This script loads and executes our formatter test. Before the QUnit test execution can be started we need to wait until the Core has been booted. Therefore, you need to disable the autostart `QUnit.config.autostart = false;`, require the `sap/ui/core/Core` module and use `Core.ready()` to wait until the Core has booted and then you can start the QUnit tests with `QUnit.start()`.
+This module is the entrypoint for all our unit tests and will be referenced in the test suite that will be created later on.


Somehow the explanation about the implementation in the file itself got lost. How about to change the description to:

This module will serve as the entry point for all our unit tests. It will be referenced in the test suite that we will set up later on.

Inside the unitTests.qunit.ts file, we import the unit test for the custom formatter. This ensures that any tests related to the custom formatter functionality will be included when running our unit tests.

Thanks 👍🏻 I've update it as suggested.

margopolo · 2024-11-13T08:22:35Z

steps/27/README.md

@@ -97,7 +97,11 @@ import "./model/formatter";

 ### webapp/test/Test.qunit.html \(New\)

-We also need a generic test page to run our tests. This is necessary as the namespace of the test code needs to be registered via the `data-sap-ui-resource-roots` attribute. The page will also be referenced in the test suite, which we're going to create next.
+We also need a generic test page that will be used to run individual tests.
+


Can we have here one additional sentence about the src="../resources/sap/ui/test/starter/runTest.js" script that is initialized in the script tag? Would be good to also mention what this script is for.

matz3 · 2024-11-14T08:21:02Z

Please do not merge yet. I will now update the files in all following steps.

matz3 · 2024-11-14T08:26:50Z

Ready for final review

steps/01/README.md

steps/27/README.md

steps/28/README.md

margopolo reviewed Oct 30, 2024

View reviewed changes

steps/27/README.md Show resolved Hide resolved

steps/27/README.md Show resolved Hide resolved

steps/27/README.md Show resolved Hide resolved

steps/27/README.md Show resolved Hide resolved

steps/27/README.md Outdated Show resolved Hide resolved

maxreichmann marked this pull request as draft October 31, 2024 08:48

maxreichmann force-pushed the use-test-starter branch 2 times, most recently from 1782e0b to ac5f6fa Compare November 7, 2024 09:26

test(Steps 27,28,29): add Test Starter

93dc5fd

* test: add CDN testsuite files * refactor: remove whitespace from legacy HelloDialogFragment.xml + mockserver.html

maxreichmann force-pushed the use-test-starter branch from ac5f6fa to 93dc5fd Compare November 7, 2024 09:41

matz3 added 4 commits November 7, 2024 11:14

docs: update Step 27 README

0931ab3

docs: update Step 28 README

9ef4b34

docs: remove animationMode and improve README wording

9a1c51c

`animationMode: minimal` is not required and not setting it simplifies the config.

docs: add note about missing types for test suite config

c3475e2

matz3 force-pushed the use-test-starter branch from 387a9a8 to c3475e2 Compare November 7, 2024 12:18

matz3 marked this pull request as ready for review November 7, 2024 15:29

matz3 requested review from flovogt, margopolo and codeworrior November 7, 2024 15:31

flovogt reviewed Nov 8, 2024

View reviewed changes

steps/27/webapp/test/Test.cdn.qunit.html Show resolved Hide resolved

flovogt previously approved these changes Nov 8, 2024

View reviewed changes

docs: Fix typo in Step 1

2879f6b

matz3 dismissed flovogt’s stale review via 2879f6b November 8, 2024 11:32

flovogt requested review from LilyanaOviPe and removed request for codeworrior November 11, 2024 08:45

matz3 reviewed Nov 11, 2024

View reviewed changes

margopolo reviewed Nov 11, 2024

View reviewed changes

matz3 added 3 commits November 11, 2024 15:11

docs: update unitTests.qunit.ts description

8cb2a5b

docs: add test suite naming convention

58cd5e1

docs: update convention / remove obsolete title

881c7ce

matz3 added 2 commits November 12, 2024 16:24

docs: additional descriptions

f3f6bfe

docs: remove double spaces

e2bc22a

margopolo reviewed Nov 13, 2024

View reviewed changes

docs: explain runTest.js script

857dcd4

margopolo previously approved these changes Nov 14, 2024

View reviewed changes

docs: update files in following steps

3eeeb9d

matz3 dismissed margopolo’s stale review via 3eeeb9d November 14, 2024 08:25

margopolo approved these changes Nov 14, 2024

View reviewed changes

matz3 merged commit 5d2b193 into SAP-samples:main Nov 14, 2024
3 checks passed

LilyanaOviPe reviewed Nov 14, 2024

View reviewed changes

steps/01/README.md Show resolved Hide resolved

steps/27/README.md Show resolved Hide resolved

steps/27/README.md Show resolved Hide resolved

steps/27/README.md Show resolved Hide resolved

steps/27/README.md Show resolved Hide resolved

steps/28/README.md Show resolved Hide resolved

matz3 mentioned this pull request Nov 14, 2024

docs: incorporate feedback #77

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add Test Starter #65

docs: add Test Starter #65

maxreichmann commented Oct 30, 2024 •

edited

Loading

margopolo left a comment •

edited

Loading

margopolo commented Oct 31, 2024

maxreichmann commented Oct 31, 2024 •

edited

Loading

codeworrior commented Nov 7, 2024

matz3 commented Nov 7, 2024 •

edited

Loading

flovogt left a comment

matz3 Nov 11, 2024

matz3 Nov 11, 2024

margopolo Nov 11, 2024

matz3 Nov 11, 2024

margopolo Nov 13, 2024

matz3 Nov 13, 2024

matz3 commented Nov 14, 2024

matz3 commented Nov 14, 2024

docs: add Test Starter #65

docs: add Test Starter #65

Conversation

maxreichmann commented Oct 30, 2024 • edited Loading

margopolo left a comment • edited Loading

Choose a reason for hiding this comment

margopolo commented Oct 31, 2024

maxreichmann commented Oct 31, 2024 • edited Loading

codeworrior commented Nov 7, 2024

matz3 commented Nov 7, 2024 • edited Loading

flovogt left a comment

Choose a reason for hiding this comment

matz3 Nov 11, 2024

Choose a reason for hiding this comment

matz3 Nov 11, 2024

Choose a reason for hiding this comment

margopolo Nov 11, 2024

Choose a reason for hiding this comment

matz3 Nov 11, 2024

Choose a reason for hiding this comment

margopolo Nov 13, 2024

Choose a reason for hiding this comment

matz3 Nov 13, 2024

Choose a reason for hiding this comment

matz3 commented Nov 14, 2024

matz3 commented Nov 14, 2024

maxreichmann commented Oct 30, 2024 •

edited

Loading

margopolo left a comment •

edited

Loading

maxreichmann commented Oct 31, 2024 •

edited

Loading

matz3 commented Nov 7, 2024 •

edited

Loading