Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: new formatting and screenshots addition #231

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
6e4bd01
feat: adding docusaurus docs project
amelnytskyi Feb 6, 2024
3315bcc
feat: adding docusaurus docs project
amelnytskyi Feb 7, 2024
cc99738
add job workflow for build testing docs
otani88 Feb 7, 2024
6af93f2
add job workflow for build testing docs
otani88 Feb 7, 2024
d947f6a
add job workflow for build testing docs
otani88 Feb 7, 2024
bb5d2a6
Merge branch 'main' into QA-613-add-docusaurus-docs-project
otani88 Feb 8, 2024
e7bbf7f
change docusaurus config for deploy
otani88 Feb 8, 2024
ee17988
re-configure build for use custom dns
otani88 Feb 8, 2024
aa2824f
re-configure build for use custom dns
otani88 Feb 8, 2024
9c981ba
add workflow for build and publish test docs
otani88 Feb 8, 2024
610e366
adding instructions to readme
amelnytskyi Feb 15, 2024
606b748
Merge branch 'main' into QA-613-add-docusaurus-docs-project
amelnytskyi Apr 8, 2024
ec4eaa3
test: fix package build on CI in docs workflow
pcheremu Apr 8, 2024
ef3a3b4
test: debug npm build
pcheremu Apr 8, 2024
367756d
test: debug npm build without husky
pcheremu Apr 8, 2024
0c083aa
test: test build
pcheremu Apr 8, 2024
e278b79
test: test build
pcheremu Apr 8, 2024
fefd445
test: build docs
pcheremu Apr 8, 2024
de4df79
test: build docs
pcheremu Apr 8, 2024
bdf931e
test: workable run of doc, do not run npm i for testing-docs
pcheremu Apr 8, 2024
a0ecd01
test: fix node dependencies (#223)
pcheremu Apr 9, 2024
34ccf3b
test: tests migration from allure
pcheremu Apr 12, 2024
8580045
test: added migration script
pcheremu Apr 12, 2024
42fabcb
test: remove extra symbols to avoid 404 pages redirection (#229)
olehbairak Apr 12, 2024
8b5b518
test: fixing folders structure for BE docs in docusaurus project (#227)
amelnytskyi Apr 12, 2024
209808c
test: test docs deployment
pcheremu Apr 13, 2024
0dd0842
test: test docs deployment
pcheremu Apr 13, 2024
48ab2fd
test: debug docs workflow
pcheremu Apr 15, 2024
caa0303
test: debug docs workflow
pcheremu Apr 15, 2024
43f6c2f
test: debug docs workflow
pcheremu Apr 15, 2024
a0b0685
Merge branch 'QA-613-add-docusaurus-docs-project' of https://github.c…
olehbairak Apr 15, 2024
9c09efe
fix: new implementation
olehbairak Apr 15, 2024
914ca21
Revert "fix: new implementation"
olehbairak Apr 15, 2024
555c8f5
fix: add screens and fixes
olehbairak Apr 15, 2024
c998360
Merge branch 'QA-613-add-docusaurus-docs-project' into oleh-bairak-qa…
olehbairak Apr 15, 2024
5a3c0da
fix: new one
olehbairak Apr 15, 2024
90519c3
fix: remove tags
olehbairak Apr 16, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
tags: ['Full test', 'manual', 'Navigation', 'Network', 'regression', 'Active']
---

# id565 Networks navigation Production - Common - Navigation to Sepolia

## Description
- Preconditions: user opens any production BE page (https://explorer.zksync.io/) with zkSync Era Mainnet network selected

## Precondition


## Scenario
- Open drop down list with networks
- Select zkSync Era Sepolia Testnet network
- User is redirected to https://sepolia.explorer.zksync.io/ domain
- The same page opened on the new domain
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
tags: ['Full test', 'manual', 'Navigation', 'Network', 'regression', 'Active']
---

# id566 Networks navigation Production - Common - Navigation to Mainnet

## Description
- Preconditions: user opens any production BE page (https://explorer.zksync.io/) with zkSync Era Sepolia network selected

## Precondition


## Scenario
- Open drop down list with networks
- Select zkSync Era Mainnet network
- User is redirected to explorer.zksync.io domain
- The same page opened on the new domain
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
tags: ['Full test', 'Navigation', 'Network', 'Smoke test', 'Automated']
---

# id561 Networks navigation Staging - Common - Navigation to Goerli - Stage 2

## Description
- Preconditions: user opens any BE page with zkSync Era Mainnet or local network selected
- Note: only local environment should be used.

## Precondition


## Scenario
- Open drop down list with networks
- Select Goerli (Stage2) network
- User is redirected to URL/?network=goerli-beta domain
- The same page opened on the new domain
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
tags: ['Full test', 'Navigation', 'Network', 'Smoke test', 'Automated']
---

# id562 Networks navigation Staging - Common - Navigation to zkSync Era Testnet

## Description
- Preconditions: user opens any BE page with zkSync Era Mainnet or Goerli (Stage2) network selected

## Precondition


## Scenario
- Open drop down list with networks
- Select zkSync Era Sepolia Testnet network
- User is redirected to URL/?network=sepolia domain
- The same page opened on the new domain
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
tags: ['Full test', 'Navigation', 'Network', 'Smoke test', 'Automated']
---

# id563 Networks navigation Staging - Common - Navigation to Mainnet

## Description
- Preconditions: user opens any BE page with zkSync Era Testnet or Goerli (Stage2) network selected

## Precondition


## Scenario
- Open drop down list with networks
- Select zkSync Era Mainnet network
- User is redirected to URL/?network=mainnet domain
- The same page opened on the new domain
Original file line number Diff line number Diff line change
@@ -1,37 +1,47 @@
---
tags: ['API', 'Common', 'Full test', 'regression', 'ZKF-2450', 'Active']
tags: ['API', 'Common', 'Full test', 'regression', 'Active']
---

# id546 API - Common - Get balance

## Description
- Create a Custom token
- Step 1
- Create your own ERC20 token on L1 on Goerli network:
- it should have the following name: 2 first letters of your First Name and 2 first letters of your Last Name. For example for me it would be ANdrii DRebot, so ANDR.
Create a Custom token

###### Step 1

Create your own ERC20 token on L1 on Goerli network:
- it should have the following name:
- 2 first letters of your First Name and 2 first letters of your Last Name.
For example for me it would be ANdrii DRebot, so ANDR.-
- it should have 18 decimals
- total supply \> 1000
- To create a token you can follow any guideline on the internet, for example this one: https://docs.alchemy.com/alchemy/tutorials/deploy-your-own-erc20-token
- Once you've done, send 50 tokens to between your L1 to confirm using MetaMask.
- Step 2

To create a token you can follow any guideline on the internet, for example this one: https://docs.alchemy.com/alchemy/tutorials/deploy-your-own-erc20-token
Once you've done, send 50 tokens to between your L1 to confirm using MetaMask.

###### Step 2
- Deposit your token from L1 to L2. For that just follow our guideline here https://v2-docs.zksync.io/api/js/getting-started.html to make a deposit. This will automatically create your token on L2.
- Make sure to use zksync-web3 v0.7.7 because the latest one does not work.
- After that go to Portal (https://staging-portal.zksync.dev/) and add your custom token there. After that you should see your token balance on Balances and Transfer pages.
- Please, be attentive and remember that token on L1 and L2 will have different addresses. Also, our block explorer will not show balances for custom tokens, but Blockscout will (https://zksync2-testnet.zkscan.io/). This is one of the ways you can get token address on L2 after a successful deposit.
- Once you've done, Send 50 tokens between your L2 to confirm using Portal UI.
- == = == = == Use API = == = == =

== = == = == Use API = == = == =
- https://zksync2-testnet.zkscan.io/api-docs#account
- Example: https://zksync2-testnet.zkscan.io/api?module=account&action=tokenlist&address=0x6cC8cf7f6b488C58AA909B77E6e65c631c204784

## Precondition
Example: https://zksync2-testnet.zkscan.io/api?module=account&action=tokenlist&address=0x6cC8cf7f6b488C58AA909B77E6e65c631c204784

## Precondition

## Scenario
- Prepare a custom token on L2
- Make a request to show the balance
- ?module=account&action=tokenlist&address=\{hash\}
- You can see the token with its balance
- ![Screenshot](../../../../static/img/screenshots/common/BlockscoutAPI/id546_1.png);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

- Default balance is empty
- Inspect -\> Network -\> Address -\> Empty balance list
![Screenshot](../../../../static/img/screenshots/common/BlockscoutAPI/id546_2.png);
- Blockscout API shows balance
- Inspect -\> Network - \> api?module... -\> Balance
![Screenshot](../../../../static/img/screenshots/common/BlockscoutAPI/id546_3.png);
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,6 @@ tags: ['Account', 'Actions', 'Common', 'Copying', 'Events', 'Active']
- Enter in Search field "goerli.explorer.zksync.io"
- Click on the correct record
- Find and disable Clipboard
![Screenshot](../../../../static/img/screenshots/common/Common_pages_part/id806_1.png)
- Open pages with Copy buttons (e.g. TX page)
- Check that no copy button is present
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
tags: ['automated', 'Footer', 'Full test', 'Redirection', 'Automated']
tags: ['Footer', 'Full test', 'Redirection', 'Automated']
---

# id232 Footer - Common - Internal links Redirection
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ tags: ['Artifacts', 'Footer', 'Full test', 'manual', 'Smoke test', 'Active']
## Scenario
- Right down corner contains correct version of the Block Explorer
- f.e. 1.34.0
![Screenshot](../../../../static/img/screenshots/common/Foot/id255_1.png)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
tags: ['automated', 'ExternalLinks', 'Full test', 'Header', 'Redirection', 'Automated']
tags: ['ExternalLinks', 'Full test', 'Header', 'Redirection', 'Automated']
---

# id231 Header - Common - External links - SN icons
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
tags: ['automated', 'Full test', 'Header', 'Redirection', 'Automated']
tags: ['Full test', 'Header', 'Redirection', 'Automated']
---

# id251 Header - Common - Internal links
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
tags: ['automated', 'Full test', 'Header', 'Redirection', 'Active Partly Manual']
tags: ['Full test', 'Header', 'Redirection', 'Active Partly Manual', 'Automated']
---

# id252 Header - Common - Internal links-BE
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
tags: ['automated', 'Full test', 'Header', 'Redirection', 'regression', 'ZKF-2447', 'Active Partly Manual']
tags: ['Full test', 'Header', 'Redirection', 'regression', 'Active Partly Manual', 'Automated']
---

# id253 Header - Common - Internal links-Tools
Expand All @@ -20,3 +20,4 @@ tags: ['automated', 'Full test', 'Header', 'Redirection', 'regression', 'ZKF-244
- https://staging-scan-v2.zksync.dev/tools/debugger
- Bridge
- https://portal.zksync.io/bridge/
![Screenshot](../../../../static/img/screenshots/common/Header/id253_1.png)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
tags: ['Artifacts', 'automated', 'Full test', 'Header', 'Automated']
tags: ['Artifacts', 'Full test', 'Header', 'Automated']
---

# id254 Header - Common - Drop Down obj
Expand All @@ -16,4 +16,4 @@ tags: ['Artifacts', 'automated', 'Full test', 'Header', 'Automated']
- Mainnet
- Drop down list to change language exist
- EN
- UA
- UA
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
tags: ['Artifacts', 'DropDown', 'Full test', 'Header', 'manual', 'regression', 'ZKF-3179', 'Active']
tags: ['Artifacts', 'DropDown', 'Full test', 'Header', 'manual', 'regression', 'Active']
---

# id705 Header - Common - Artifacts - Network Drop Down
Expand All @@ -15,3 +15,4 @@ tags: ['Artifacts', 'DropDown', 'Full test', 'Header', 'manual', 'regression', '
- "zkSync Era Sepolia Testnet" item
- "zkSync Era Mainnet" item
- zkSync logo available for each network
![Screenshot](../../../../static/img/screenshots/common/Header/id705_1.png)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
tags: ['Full test', 'manual', 'Navigation', 'Network', 'regression', 'To Automate', 'ZKF-2507', 'Active']
tags: ['Full test', 'manual', 'Navigation', 'Network', 'regression', 'To Automate', 'Active']
---

# id565 Networks navigation Production - Common - Navigation to Sepolia
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
tags: ['Full test', 'manual', 'Navigation', 'Network', 'regression', 'To Automate', 'ZKF-2507', 'Active']
tags: ['Full test', 'manual', 'Navigation', 'Network', 'regression', 'To Automate', 'Active']
---

# id566 Networks navigation Production - Common - Navigation to Mainnet
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
tags: ['Full test', 'manual', 'Navigation', 'Network', 'Smoke test', 'ZKF-2507', 'Automated']
tags: ['Full test', 'Navigation', 'Network', 'Smoke test', 'Automated']
---

# id561 Networks navigation Staging - Common - Navigation to Goerli - Stage 2
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
tags: ['Full test', 'manual', 'Navigation', 'Network', 'Smoke test', 'ZKF-2507', 'Automated']
tags: ['Full test', 'Navigation', 'Network', 'Smoke test', 'Automated']
---

# id562 Networks navigation Staging - Common - Navigation to zkSync Era Testnet
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
tags: ['Full test', 'manual', 'Navigation', 'Network', 'Smoke test', 'ZKF-2507', 'Automated']
tags: ['Full test', 'Navigation', 'Network', 'Smoke test', 'Automated']
---

# id563 Networks navigation Staging - Common - Navigation to Mainnet
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ tags: ['Artifacts', 'Full test', 'Single-file', 'Smart Contract Verification pag

## Scenario
- SCV interface:
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1619_1.png)
- Notification
- You can also verify your smart-contract using HardHat Plugin
- Link - "HardHat Plugin"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ tags: ['Actions', 'Artifacts', 'Full test', 'Single-file', 'Smart Contract Verif
- Enter the Vyper Contract Code
- Constructor Arguments
- Click on Clear button
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1620_1.png)
- Verify text fields are cleared
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1620_2.png)
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1620_3.png)
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1620_4.png)
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1620_5.png)
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1620_6.png)
- Verify "Zkvyper version" and "Vyper Version" dropdowns set to default values (latest versions)
- Verify "Optimization" radio buttons set to default values (Yes)
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ tags: ['Common', 'FNC', 'Full test', 'manual', 'Positive', 'Smart Contract Verif
- Pass the tutorial
- Open https://goerli.explorer.zksync.io/contracts/verify
- Select Vyper (Single file) in "Compiler type"
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1621_1.png)
- Fill all the fields and verify the contract
- Success screen shown after contract verification
- Success mark displayed
Expand All @@ -22,4 +23,5 @@ tags: ['Common', 'FNC', 'Full test', 'manual', 'Positive', 'Smart Contract Verif
- Text
- Anyone on block explorer could check it's code and interact with it
- "Block explorer" is a link
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1621_2.png)
- "Back to Contract" button
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ tags: ['Common', 'FNC', 'Full test', 'manual', 'Multi-contract', 'Positive', 'Sm
- Pass the tutorial
- Open https://goerli.explorer.zksync.io/contracts/verify
- Select "Vyper (Multi-part contract)" in "Compiler type"
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1625_1.png)
- Fill all the fields and verify the contract
- Success screen shown after contract verification
- Success mark displayed
Expand All @@ -23,3 +24,4 @@ tags: ['Common', 'FNC', 'Full test', 'manual', 'Multi-contract', 'Positive', 'Sm
- Anyone on block explorer could check it's code and interact with it
- "Block explorer" is a link
- "Back to Contract" button
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1625_2.png)
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ tags: ['Artifacts', 'Full test', 'Multi-contract', 'Smart Contract Verification

## Scenario
- SCV interface:
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1626_1.png)
- Notification
- You can also verify your smart-contract using HardHat Plugin
- Link - "HardHat Plugin"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ tags: ['Common', 'Full test', 'manual', 'Positive', 'Proxy Contract', 'regressio
- Open https://goerli.explorer.zksync.io/contracts/verify
- Select "Solidity (Single file)" in "Compiler type"
- Fill all the fields and verify the contract
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1672_1.png)
- Success screen shown after contract verification
- Success mark displayed
- Headline
Expand All @@ -23,3 +24,4 @@ tags: ['Common', 'Full test', 'manual', 'Positive', 'Proxy Contract', 'regressio
- Anyone on block explorer could check it's code and interact with it
- "Block explorer" is a link
- "Back to Contract" button
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1672_2.png)
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ tags: ['Common', 'Full test', 'manual', 'Positive', 'Proxy Contract', 'Smart Con
## Scenario
- Deploy the contract (according to the manual in description)
- Open Proxy contract you will see next 2 new tabs:
- : "Read as Proxy"
- : "Write as Proxy"
- : "The implementation contract at \{Contract Address\} is not verified.
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1673_1.png)
- "Read as Proxy"
- "Write as Proxy"
- "The implementation contract at \{Contract Address\} is not verified.
- Please verifv the implementation contract in order to Read/Write the contract as Proxv."
- Verify implementation contract:
- : "Implementation contract found at \{Contract Address\}"
- "Implementation contract found at \{Contract Address\}"
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1673_2.png)
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ tags: ['Artifacts', 'Common', 'Full test', 'Header', 'Smart Contract Verificatio
- Text - "Smart Contract Verification"
- Text
- Source code verification provides transparency for users interacting with smart contracts. By uploading the source code, Era Explorer will match the compiled code with that on the blockchain.
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1871_1.png)
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ tags: ['Actions', 'Artifacts', 'Full test', 'Smart Contract Verification page',
## Scenario
- Select "Solidity (Single file)" or "Solidity (Multi-part contract)" in "Compiler type" dropdown
- Mark the "zkEVM" checkbox
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1906_1.png)
- Verify only zkVM versions shown in the "Solc Version" dropdown
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1906_2.png)
- Unmark the "zkEVM" checkbox
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1906_3.png)
- Verify only solc versions shown in the "Solc Version" dropdown
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id1906_4.png)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
tags: ['Artifacts', 'automated', 'Full test', 'Single-file', 'Smart Contract Verification page', 'Smoke test', 'Solidity', 'Active Partly Manual']
tags: ['Artifacts', 'Automated', 'Full test', 'Single-file', 'Smart Contract Verification page', 'Smoke test', 'Solidity', 'Active Partly Manual']
---

# id212 SmartContractVerification page - Common - Artifacts - Smart contract verification (UI for Single-Contract Solidity)
Expand All @@ -12,6 +12,7 @@ tags: ['Artifacts', 'automated', 'Full test', 'Single-file', 'Smart Contract Ver

## Scenario
- SCV interface:
![Screenshot](../../../../static/img/screenshots/common/SmartContractVerification/id212_1.png)
- Notification
- You can also verify your smart-contract using HardHat Plugin
- Link - "HardHat Plugin"
Expand Down Expand Up @@ -40,7 +41,7 @@ tags: ['Artifacts', 'automated', 'Full test', 'Single-file', 'Smart Contract Ver
- Text under the field: Relative path to your contract at the moment of compilation
- Enter the Solidity Contract Code
- Field for Solidity code
- Text: "If your contract uses "imports", you will need to concatenate the code into one file ( otherwise known as "flattening" ). For that purpose you can use solidity-flattener or SolidityFlattery"
- Text: "If your contract uses "imports", you will need to concatenate the code into one file (otherwise known as "flattening"). For that purpose you can use solidity-flattener or SolidityFlattery"
- Link: solidity-flattener
- Link: SolidityFlattery
- Constructor Arguments
Expand Down
Loading
Loading