Nightwatch 3rd party integration docs

[harshit-bs]

PRs

• #191
• #199
• https://github.com/nightwatchjs/nightwatch-www/pull/57
• https://github.com/nightwatchjs/nightwatch-www/pull/58

Documentation Link

https://drive.google.com/drive/folders/1YJPOxGPmpgY3B9H1eV_l0r_Swo8bIup_?usp=sharing

3rd party integration's tracker

Category	Integration	Priority	Configured	Test works	Written doc	Converted to .md file	Status	Comments
CI Integration	GitHub Actions	P0	✅	✅	Link ✅	✅	🚀	This integration will be easy if you are familiar with xvfb tool or have little knowledge of writing CI pipelines
CI Integration	Bamboo	P0	✅	✅	Link ✅	✅	🚀	The most difficult part of this integration was setting up Bamboo on localhost.
CI Integration	Azure Pipelines	P0	✅	✅	Link ✅	✅	🚀	Credential was the most challenging part of this integration
CI Integration	Circle CI	P1					⌛	@vishalshah133 is working on it
CI Integration	Gitlab CI	P1					⌛	@vishalshah133 is working on it
Reporter	JSON	P0	✅	✅	Link ✅	✅	🚀	It was the most easiest one
Reporter	Nightwatch-Allure-Reporter	P0	✅	✅	Link ✅	✅	🚀	Problem 🐛 : Although I've written the doc but it is no longer being maintained.
Reporter	nightwatch-slack-reporter	P0	✅	✅	Link ✅	✅	🚀	Problem 🐛 : It's been stale for 6 years. Problem Resolved 🎉 : It requires a slack webhook url in order to configure and test. And it needs to be approved by the admin of Browserstack's slack workspace. But I'd created my own workspace to overcome the overhead 😄
Reporter	Teamcity Reporter	P0	✅	✅	Link ✅	✅	🚀	Problem 🐛 : Somehow the process is not getting closed while composing with other reporters Problem Resolved 🎉 : Above issue is resolved now and doc updated accordingly
Reporter	nightwatch-cucumber	P1	✅				❌	It is now deprecated so there is no point to write the documentation for it. Also it is not a reporter but it was internally supporting cucumber tests which is now already been introduced in the nightwatch-v2.
Test Runner	Jest	P0	✅	✅	Link ✅	✅	🚀	Little knowledge of Jest is enough for this integration
Test Runner	Ava	P0	✅	✅	Link ✅	✅	🚀	Problem 🐛 : Previously introduced a limitation to add the following code in every test files because the tests are not waiting to launch the browser and we were encountering an error stating that browser is not defined : test.before(async (t) => { global.browser = await browser; });. Problem Resolved 🎉 : Above issue is resolved now and doc updated accordingly

[harshit-bs]

1. Nightwatch-Allure-Reporter :

   • Although I've written the doc for Nightwatch-Allure-Reporter but it is no longer being maintained.

   • It needs to be converted in the .md file https://docs.google.com/document/d/173teWu4YpR8pBa8HIeIECMblhgY39hgTqtD5WRB4Hh4/edit

   • Configured and tested in local and it works

2. nightwatch-cucumber : It is now deprecated so there is no point to write the documentation for it. Also it is not a reporter but it was internally supporting cucumber tests which is now already been introduced in the nightwatch-v2.

3. JSON Reporter :

   • It needs to be converted in the .md file with some changes https://docs.google.com/document/d/1RGjN2lu8JWK35VW-6jCEZW4SoR8gGEjr7kAeqScRXAo/edit?usp=sharing

   • Configured and tested in local and it works

4. nightwatch-slack-reporter : [WIP] It requires a slack webhook url (https://api.slack.com/messaging/webhooks) in order to configure and test. And it needs to be approved by the admin of Browserstack's slack workspace. Doc is here https://docs.google.com/document/d/1AqeW0qRsE2zWCbRij8CRuwYsh932y8DaJ0Z-tv4UiQM/edit

5. Jest test runner

   • Configured and tested in local and it works
   • Doc : https://docs.google.com/document/u/2/d/1pD2vaqCAKaZd_h8WApyu2CghM-wfYkpGNKq_ad5Sg4A/edit?usp=drive_web&ouid=113839687598854063070

6. Ava test runner

   • Configured and tested in local and it works
   • Doc : https://docs.google.com/document/d/1JoUQCfMrhqffs2bv5n-mZ1YR8EuI83sfHFIiTzNbeow/edit

7. Github Action

   • Configured and tested in local and it works
   • Doc : https://docs.google.com/document/d/1HeGMYDDqh5OF1qfQjNjOdK3Lo6T8oWmGqH4Ky5y2q5w/edit

8. Bamboo

   • Configured and tested in local and it works
   • Doc : https://docs.google.com/document/d/1Up7GIN_gqgMm8WWxWGrC64SHrSNNYTjMKV3j08vPSaY/edit?usp=sharing

9. Azure Pipelines :

   • Configured and tested and it works
   • Doc : https://docs.google.com/document/d/1kQrh5lHTcY_52QQNA7MLbhuOBQAyMsR7i38aHbAywTc/edit?usp=sharing

10. Teamcity Reporter

    • Configured and tested and it works
    • Doc : https://docs.google.com/document/d/1jv-NWO87jwfV9s3ASrFHgPVrmqSTBiukN6PrA_EHCxA/edit?usp=sharing

[AutomatedTester]

@harshit-bs when you have completed the azure docs and the github actions docs could you just let me and @vishalshah133 know, there might be opportunities for us to improve create-nightwatch here to get people started quickly.

[vishalshah133]

Reviewed Allure and JSON reporters. We can convert to .md file and create PRs for those 2

[vishalshah133]

Reviewed Github actions. Have left some comments

[vishalshah133]

Reviewed Ava & Jest test runners. Have left comments

[harshit-bs]

Converted Allure and JSON reporters to .md file and raised a PR for those. And comments resolved for Github actions, Ava & Jest test runners.

[harshit-bs]

Added document for Bamboo, Azure Pipelines and Team-City

[harshit-bs]

Added document for Slack Reporter.

[harshit-bs]

Raised PRs for left navbar of above articles

[harshit-bs]

Added comments, URLs and updated status for all integrations in above tracker table