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

Adding Functional Auto Test Plan Documentation into Repo ReadMe #735

Open
rgbrow1949 opened this issue Dec 12, 2023 · 3 comments · May be fixed by #983
Open

Adding Functional Auto Test Plan Documentation into Repo ReadMe #735

rgbrow1949 opened this issue Dec 12, 2023 · 3 comments · May be fixed by #983
Assignees
Labels
documentation This issue or pull request improves or adds to documentation
Milestone

Comments

@rgbrow1949
Copy link
Collaborator

rgbrow1949 commented Dec 12, 2023

For the automatic functional tests, we should add instructions on how to write functional testing scripts in a README on the Scuba git repo.

Example of a test script:

$WebDriversPath = Join-Path -Path (Get-Module Selenium).ModuleBase -ChildPath "assemblies"
.\Testing\Functional\SmokeTest\UpdateSelenium.ps1 -webDriversPath $WebDriversPath

$TestContainers = @()
$TestContainers += New-PesterContainer -Path "./Testing/Functional/Products" `
-Data @{
	TenantDomain = "cisaent.onmicrosoft.com";
	Thumbprint = "<your thumbprint here>";
	AppId = "<app id>";
	TenantDisplayName = "Cybersecurity and Infrastructure Security Agency";
	ProductName = "teams";
	M365Environment = "gcc" }
Invoke-Pester -Container $TestContainers -Output Detailed
@schrolla
Copy link
Collaborator

For the automatic functional tests, we should add instructions on how to write functional testing scripts in a README on the Scuba git repo.

Example of a test script:

$WebDriversPath = Join-Path -Path (Get-Module Selenium).ModuleBase -ChildPath "assemblies"
.\Testing\Functional\SmokeTest\UpdateSelenium.ps1 -webDriversPath $WebDriversPath

$TestContainers = @()
$TestContainers += New-PesterContainer -Path "./Testing/Functional/Products" `
-Data @{
	TenantDomain = "cisaent.onmicrosoft.com";
	Thumbprint = "<your thumbprint here>";
	AppId = "<app id>";
	TenantDisplayName = "Cybersecurity and Infrastructure Security Agency";
	ProductName = "teams";
	M365Environment = "gcc" }
Invoke-Pester -Container $TestContainers -Output Detailed

Yes, and the document should be wholly separate from the user-facing documentation since it is for developers. Either we create a docs folder so its out of the way and we can further organize into subfolders or create a docs folder under Testing perhaps. Either way, it should be largely transparent and out of the way for a normal user who will never create a test plan or script.

@schrolla schrolla added the documentation This issue or pull request improves or adds to documentation label Dec 18, 2023
@schrolla schrolla added this to the Glacier - Sprint 1 Feb 2024 milestone Dec 18, 2023
@nanda-katikaneni nanda-katikaneni self-assigned this Feb 8, 2024
@james-garriss
Copy link
Collaborator

This is related to but distinct from #877.

@nanda-katikaneni nanda-katikaneni modified the milestones: Glacier, Halibut Apr 8, 2024
@nanda-katikaneni
Copy link
Collaborator

The PR #983 fixing this issue is pushed to Halibut - changing the targeted release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation
Projects
None yet
4 participants