docs(testing/plan): add functional test plan #596

tselit · 2024-09-13T14:55:20Z

Context

Document a test plan for the Web Monetization extension, detailing the functional test cases.

Closes #290.

Changes proposed in this pull request

The test plan in markdown format, alongside an image asset that visualises how the test cases relate to each other.

add test plan

Add 7 sections.

Add risks and test case diagram

add assets for testing

add a mindmap of the test cases

this folder was meant to be in the test/testplan folder

a folder for the test plan assets

add 3 basic test cases

Added the following test cases: - Pay one-time when extension funds are insufficient. - Disable continuous payments.

Added the following 4 test cases: - Pay one-time when extension funds are insufficient - Disable continuous payments - Change rate of pay and View available balance - Disconnect wallet

- update test case for a partial one-time payment success due to insufficient extension funds - add test case to pay until the extension runs out of funds

github-actions · 2024-09-13T14:56:24Z

Extension builds preview

Name	Link
Latest commit	`b4eab24`
Latest job logs	Run #11254757474
	Download
	Download

add WICG to the dictionary

test/testplan/assets/WM-Extension-Test-Cases.jpg

test/testplan/testplan.md

melissahenderson · 2024-09-30T14:30:53Z

docs/testing/testplan.md

+You have the option to use “play” money from the [Interledger Test Wallet application](https://rafiki.money/).  
+Here you can set up an account that is enabled for Web Monetization, and other Interledger functionality, without involving real money.
+
+You can learn more about the [Interledger Test Wallet here](https://rafiki.dev/integration/playground/testnet/).


This may not be the best place to link to. As a WM tester, it's sending me to a page that talks about trying out Rafiki. It doesn't give me any info about setting up a WM account. I might think you've sent me to the wrong place.

Cool, that's a fair point, thanks Melissa.
I think we can safely eliminate the "You can learn more about..." sentence.

melissahenderson · 2024-09-30T14:30:55Z

docs/testing/testplan.md

+
+The resources and tools that you will need to test Web Monetization depend on your desired role, and what you want to test.
+
+We’ve identified three roles you can play when using Web Monetization:


Suggestion: If the only role we are wanting people to play is that of a website visitor, I suggest removing all the other information about website owner and developer. You also don't really need the table if website owner is the only thing listed in it.

melissahenderson · 2024-09-30T14:30:59Z

docs/testing/testplan.md

+
+### Reporting Issues
+
+1. Use any screen recording application to record the steps and results of your testing.


There was previously a suggestion of Loom, I believe. Was that removed on purpose? Are we assuming that the people who test this will already have an app?

Yes, I had removed the Loom example on purpose. I wasn't too keen for the docs to have an opinion...but, I've put the example back in....I don't feel very strongly so am happy to align with you.

melissahenderson · 2024-09-30T14:31:01Z

docs/testing/testplan.md

+
+### Prerequisites
+
+Before you start testing, sign-up for a wallet:


Should we mention that the prereqs are different for the Test wallet?

melissahenderson · 2024-09-30T14:31:04Z

docs/testing/testplan.md

+
+### Test Data
+
+This table describes the different ways that you can set up a website that is monetized, and a website that isn’t monetized, so that you can test the Web Monetization extension.


The tester isn't setting up any websites. "...different ways that you can set up a website that is monetized..." I don't know if a tester needs to know this information.

melissahenderson · 2024-09-30T14:31:08Z

docs/testing/testplan.md

+
+**Important**
+
+1. The playground itself is not web monetized.


Suggestion: "The playground itself is not web monetized. We do not receive any payments from you if you use this site."

melissahenderson · 2024-09-30T14:31:11Z

docs/testing/testplan.md

+1. The playground itself is not web monetized.
+2. The playground becomes monetized when you add one or more receiving wallet addresses to it.
+3. If your Web Monetization extension is connected to a real wallet, then your extension will facilitate payments from your real wallet (i.e. real money).
+4. Similarly, if your extension is connected to a play wallet (i.e. rafiki.money), then the extension facilitates payments using play money.


What happens if I add one play wallet address and one real wallet address to the playground?

It depends on:

the wallet that your extension is connected to;

which of one the receiving wallets your wallet is peered with...so, if the playground has 1 test wallet address, and 1 real wallet address, and your extension is connected to a test wallet address, then each time you try to pay with the extension, your test wallet will try to pay half of the one-time payment to the receiving test wallet on the playground (ref: Test ID 9)

melissahenderson · 2024-09-30T14:31:14Z

docs/testing/testplan.md

+Based on these risks, the sections that follow will detail the actual test cases.
+
+<!-- prettier-ignore-start -->
+We use 4 risk priorities: `critical` | `high` | `medium` | `low`


Four are listed, but only criticals and highs are listed. Two suggestions: First, list them in order of importance with criticals appearing first. Second, if everything really is only critical or high, remove mention of medium and low.

Cool, and done, thanks

melissahenderson · 2024-09-30T14:31:21Z

docs/testing/testplan.md

+
+**Steps**:
+
+1. Visit a monetized website. Refer to the [Test Data](#Test-Data) section to explore different WM conditions for websites.


I mentioned earlier that I didn't know how useful/helpful it was to have that Test Data section. I'm commenting here in case that section comes out.

The less familiar a tester is with WM, the more I'm afraid that the test playground is going to be totally meaningless and confusing to them. Ideally, we want to mimic the conditions under which WM payments would be made. Which means the tester would simply go to a site. They wouldn't have to go to a test site and plug in 1+ wallet addresses. Just my 2 cents.

Thanks Melissa.
Please have a look at the revised Test Data section.
It's more explicit, and hopefully clearer about (1) websites that can be used during testing and (2) wallet addresses that a tester can use on the WM playground.

melissahenderson · 2024-09-30T14:31:24Z

docs/testing/testplan.md

+**Steps**:
+
+1. Visit a monetized website. Refer to the [Test Data](#Test-Data) section to explore different WM conditions for websites.
+2. Visit a non-monetized website. Open the extension to observe its available options.


We should suggest a URL or site. Give them a little more direction. We could say "Visit a non-web monetized website, such as your favorite search engine."

melissahenderson · 2024-09-30T14:31:26Z

docs/testing/testplan.md

+1. Visit a monetized website. Refer to the [Test Data](#Test-Data) section to explore different WM conditions for websites.
+2. Visit a non-monetized website. Open the extension to observe its available options.
+
+**Expected results**:


It would be nice, but not necessary, if we could include screenshots of what they should see in the extension.

Let me note the inclusion of screenshots for the future.
For now, I'd like to get this version of the test plan merged without them.

melissahenderson · 2024-09-30T14:31:30Z

docs/testing/testplan.md

+
+**Steps**:
+
+1. Visit a monetized website. Refer to the [Test Data](#Test-Data) section to explore different WM conditions for websites.


Reminder that there's mention of Test Data here. Testers probably don't care about the different conditions if we're asking them to specifically visit a web monetized site.

Yep, that's a fair point. I've updated the wording like this:

Visit a monetized website. The Test Data section lists monetized websites that you can visit.

melissahenderson · 2024-09-30T14:31:34Z

docs/testing/testplan.md

+##### Pay one-time when wallet is out of funds
+
+**Test ID**: 4  
+**Description**: Send a one-time payment to a monetized website when the extension has a sufficient remaining balance but the wallet has insufficient funds  


I wonder how difficult it will be for testers to set up this scenario. Because they'd have to spend/move the existing funds in their wallet. Also, Test ID 5 wants the wallet to have sufficient funds, so maybe 5 should come before 4.

Alrighty, both points addressed, thanks!

melissahenderson · 2024-09-30T14:31:41Z

docs/testing/testplan.md

+
+**Steps**:
+
+1. Visit a monetized website that has multiple receiving wallet addresses or payment pointers.  


I don't think most testers are going to know of a website that meets this criteria.

That's a fair point, thanks!
The steps for Test ID 9 now give a tester explicit guidance on this.

sidvishnoi

I'm ok merging this as is now, before it gets more out of sync with coming changes.
Added some suggestions.

Would expect a follow-up update to this document before our next release so document stays in sync with release version.

docs/testing/testplan.md

Co-authored-by: Sid Vishnoi <[email protected]>

tselit added 15 commits August 21, 2024 16:42

Create TestPlan.md

1aa26ce

add test plan

Update TestPlan

daeb026

Add 7 sections.

Update TestPlan

9cb1e63

Add risks and test case diagram

Create .keep

0e360b4

add assets for testing

add test cases image

4d66eb9

add a mindmap of the test cases

Delete assets directory

2768ebf

this folder was meant to be in the test/testplan folder

Create testplan assets folder

e528c76

a folder for the test plan assets

Add test plan diagram

2bb28c9

move testplan to folder

8f36cef

add test case 1 (connect)

60fa92e

Update Test Plan

4461078

add 3 basic test cases

Update test plan: add 2 test cases

3cc13a4

Added the following test cases: - Pay one-time when extension funds are insufficient. - Disable continuous payments.

Update test plan: add 4 basic test cases

0f232b3

Added the following 4 test cases: - Pay one-time when extension funds are insufficient - Disable continuous payments - Change rate of pay and View available balance - Disconnect wallet

Update test plan: add 3 test cases

f8cd92b

Update Test Plan: add 2 test cases

0ffbe31

- update test case for a partial one-time payment success due to insufficient extension funds - add test case to pay until the extension runs out of funds

tselit added the area: documentation Improvements or additions to documentation label Sep 13, 2024

tselit added this to the Public Beta release milestone Sep 13, 2024

tselit requested review from RabebOthmani, sidvishnoi and melissahenderson September 13, 2024 14:55

tselit removed this from the Public Beta release milestone Sep 13, 2024

tselit changed the title ~~docs (test plan/functional tests): 8 basic test cases & 3 edge test cases~~ docs: functional test plan Sep 13, 2024

tselit and others added 5 commits September 13, 2024 18:49

prettier format test plan

84cd7e3

fix spelling for lint checks

c006bb8

another lint check

ecac4ed

address prettier check

e3c4b9f

Update cspell-dictionary with WICG

2a6d1fc

add WICG to the dictionary

sidvishnoi reviewed Sep 16, 2024

View reviewed changes

test/testplan/assets/WM-Extension-Test-Cases.jpg Outdated Show resolved Hide resolved

sidvishnoi reviewed Sep 16, 2024

View reviewed changes

test/testplan/testplan.md Outdated Show resolved Hide resolved

melissahenderson reviewed Sep 30, 2024

View reviewed changes

tselit added 2 commits October 8, 2024 18:16

updates for review notes

47e63d9

resolve lint checks

eaa3484

tselit requested a review from melissahenderson October 8, 2024 20:17

sidvishnoi changed the title ~~docs: functional test plan~~ docs(testing/plan): add functional test plan Oct 9, 2024

sidvishnoi approved these changes Oct 9, 2024

View reviewed changes

tselit and others added 11 commits October 9, 2024 13:54

peer review update: update error message

8f2eb8b

Co-authored-by: Sid Vishnoi <[email protected]>

peer review update: add image

dad02b6

Co-authored-by: Sid Vishnoi <[email protected]>

peer review update: show full URL

815ce19

Co-authored-by: Sid Vishnoi <[email protected]>

peer review update: edit grammar

08803b4

Co-authored-by: Sid Vishnoi <[email protected]>

peer review update: add footnote for test wallet

4ec5b01

Co-authored-by: Sid Vishnoi <[email protected]>

peer review update: rewording reference to GitHub

9d30e43

Co-authored-by: Sid Vishnoi <[email protected]>

peer review update: edit case formatting for proper nouns

b563585

Co-authored-by: Sid Vishnoi <[email protected]>

peer review update: reword reference to compatible wallets

ff2fcd7

Co-authored-by: Sid Vishnoi <[email protected]>

peer review update: edit Fynbos wallet URL

7ee2cd2

Co-authored-by: Sid Vishnoi <[email protected]>

peer review update: edit GateHub wallet URL

3eedcc9

Co-authored-by: Sid Vishnoi <[email protected]>

Merge branch 'main' into mt/docs/test/testplan

b4eab24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(testing/plan): add functional test plan #596

docs(testing/plan): add functional test plan #596

tselit commented Sep 13, 2024

github-actions bot commented Sep 13, 2024 •

edited

Loading

melissahenderson Sep 30, 2024

tselit Oct 1, 2024

melissahenderson Sep 30, 2024

melissahenderson Sep 30, 2024

tselit Oct 1, 2024 •

edited

Loading

melissahenderson Sep 30, 2024

tselit Oct 1, 2024 •

edited

Loading

melissahenderson Sep 30, 2024

melissahenderson Sep 30, 2024

melissahenderson Sep 30, 2024

tselit Oct 1, 2024 •

edited

Loading

melissahenderson Sep 30, 2024

tselit Oct 8, 2024

melissahenderson Sep 30, 2024

tselit Oct 8, 2024

melissahenderson Sep 30, 2024

melissahenderson Sep 30, 2024

tselit Oct 8, 2024

melissahenderson Sep 30, 2024

tselit Oct 8, 2024

melissahenderson Sep 30, 2024

tselit Oct 8, 2024

melissahenderson Sep 30, 2024

tselit Oct 8, 2024

sidvishnoi left a comment


		The resources and tools that you will need to test Web Monetization depend on your desired role, and what you want to test.

		We’ve identified three roles you can play when using Web Monetization:


		### Reporting Issues

		1. Use any screen recording application to record the steps and results of your testing.


		### Prerequisites

		Before you start testing, sign-up for a wallet:


		### Test Data

		This table describes the different ways that you can set up a website that is monetized, and a website that isn’t monetized, so that you can test the Web Monetization extension.


		Steps:

		1. Visit a monetized website. Refer to the [Test Data](#Test-Data) section to explore different WM conditions for websites.


		Steps:

		1. Visit a monetized website that has multiple receiving wallet addresses or payment pointers.

docs(testing/plan): add functional test plan #596

Are you sure you want to change the base?

docs(testing/plan): add functional test plan #596

Conversation

tselit commented Sep 13, 2024

Context

Changes proposed in this pull request

github-actions bot commented Sep 13, 2024 • edited Loading

Extension builds preview

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tselit Oct 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tselit Oct 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tselit Oct 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sidvishnoi left a comment

Choose a reason for hiding this comment

github-actions bot commented Sep 13, 2024 •

edited

Loading

tselit Oct 1, 2024 •

edited

Loading

tselit Oct 1, 2024 •

edited

Loading

tselit Oct 1, 2024 •

edited

Loading