Move `get-codeowners.ps1` test mode to `common-tests` + related improvements & cleanup #5608

konrad-jamrozik · 2023-03-02T23:29:15Z

This PR moves the Test flag away from get-codeowners.ps1 to the established eng/common-tests infrastructure, using PowerShell Pester testing framework. As such, it solves:

Move the test flag from get-codeowners.ps1 to the common PS1 test infra, common-tests #5434

This PR also:

adds a README for the eng/common-tests;
extracts the get-codeowners.lib.ps1, so that the functions can be reused between normal get-codewners.ps1 usage and through Pester unit test invocations coming from get-codeowners.tests.ps1;
changes some paths for related scripts and test scripts;
moves some default params to get-codeowners.lib.ps1 and hides some unused params; this was necessary to avoid default param value duplication between calls from get-codeowners.ps1 and from get-codeowners.tests.ps1;
applies some refactorings.

Associated changes made manually once this PR got merged:

deleted internal pipeline tools - eng-common-tests; instead, created the public equivalent: tools - eng-common-tests - ci.
- For context, see this comment.

Follow-up work:

Have a dedicated pipeline for running tests in /eng/scripts/ + fix naming convention #5878

azure-sdk · 2023-03-02T23:37:58Z

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

azure-sdk · 2023-03-02T23:59:48Z

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

azure-sdk · 2023-03-03T17:19:59Z

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

eng/common-tests/ci.yml

eng/common/pipelines/templates/stages/archetype-sdk-tool-pwsh.yml

azure-sdk · 2023-03-03T17:29:05Z

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

azure-sdk · 2023-03-03T17:42:43Z

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

azure-sdk · 2023-03-03T17:47:59Z

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

weshaggard · 2023-03-03T17:56:17Z

eng/common-tests/README.md

+
+## When tests in this directory are executed
+
+The PowerShell Pester unit tests will be executed by the [`tools - eng-common-tests`](https://dev.azure.com/azure-sdk/internal/_build/results?buildId=220791) pipeline


Does this need to be an internal pipeline? If it doesn't require secrets which I don't believe it does we should move it to public. That way we can have it automatically trigger for any PR.

I created a public equivalent:
https://dev.azure.com/azure-sdk/public/_build?definitionId=5985&_a=summary

Once this PR is merged, I will delete the internal version:
https://dev.azure.com/azure-sdk/internal/_build?definitionId=5809
(update: deleted as of 3/30/2023, but since about at least 2 weeks before)

and also the internal tools eng-script-tests, which appears redundant to me:

https://dev.azure.com/azure-sdk/internal/_apps/hub/ms.vss-build-web.ci-designer-hub?pipelineId=5823

Yes we can combine them if they are doing similar things.

For the public pipeline we generally add the "- ci" postfix. So tools - eng-common-tests - ci or tools - script-tests - ci if we make it more generic.

Renamed to tools - eng-common-tests - ci. The tools - script-tests looks to be totally redundant to me, just a subset of eng-common-tests, so I will outright delete it.

OK correction: the script-tests was running tests in eng/scripts but we have since moved all such tests to eng/common-tests. I confirmed this by invoking pester on eng/scripts - it found no tests to run.

OK I'm supportive of having just the one script testing pipeline.

@weshaggard ungh, actually, there are tests, in:

eng\scripts\contentreplacements\tests\Repo-File-Content-Replacements\Repo-File-Content-Replacements.Tests.ps1

I was just running pester against scripts instead of eng/scripts. I have a task to merge these dirs.

In any case, I cannot delete that pipeline yet. But I am thinking to take all the tests in eng/scripts (which is just the one file above) and move them to eng/common-tests and rename eng/common-tests to e.g. eng/powershell-tests.

Does that sound reasonable?

If so, I'll make a separate PR for that, and for now hold off with any changes to the tools - script-tests pipeline.

Two things.

1. PowerShell test pipeline setup

I had a chat with @weshaggard. We should keep multiple pipelines

one pipeline for running PowerShell tests in /eng/common-tests/;

one pipeline per each language repo for running PowerShell tests in its /eng/scripts/ dir.

This is because:

There are two separate sets of PowerShell scripts: /eng/common/scripts/ and /eng/scripts/ and both these sets need to have tests written for them.

The dir /eng/scripts/ in each language repo has language-repo-specific scripts; currently they hardly have any tests, but in the future they should have more tests.

The pipelines can be sourced from different ci.yml files - the ci.yml source would differ only by parameters passed to the underlying abstraction for running Pester tests. Most importantly, the TargetDirectory would point to appropriate dir.

2. PowerShell file naming conventions

Per chat in this PR and over Teams between me, @weshaggard and @benbp we want to adopt following convention for naming files:

/eng/scripts/foo.ps1 and /eng/common/scripts/foo.ps1 for directly-invocable entry points;

/eng/scripts/foo.lib.ps1 and /eng/common/scripts/foo.lib.ps1 for dot-sourceable functions; the foo.ps1 is expected to be in practice just a delegate calling the "entry point" function from foo.lib.ps1;

/eng/scripts/foo.tests.ps1 and /eng/common-tests/foo.tests.ps1 for Pester tests for foo.lib.ps1.

Created an issue to track the work above:

Have a dedicated pipeline for running tests in /eng/scripts/ + fix naming convention #5878

eng/common/scripts/get-codeowners/get-codeowners.ps1

azure-sdk · 2023-03-03T17:59:12Z

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

azure-sdk · 2023-03-03T18:47:58Z

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

azure-sdk · 2023-03-03T20:05:18Z

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

azure-sdk · 2023-03-06T20:40:13Z

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

eng/common-tests/get-codeowners/get-codeowners.tests.ps1

…o it

…ts` pipeline

…t param values

…ncludeNonUserAliases as switch

azure-sdk · 2023-03-31T05:53:53Z

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

Sync eng/common directory with azure-sdk-tools for PR Azure/azure-sdk-tools#5608 See [eng/common workflow](https://github.com/Azure/azure-sdk-tools/blob/main/eng/common/README.md#workflow) --------- Co-authored-by: Konrad Jamrozik <kojamroz@microsoft.com>

ghost · 2023-03-31T06:56:13Z

Hello @azure-sdk!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

Sync eng/common directory with azure-sdk-tools for PR Azure/azure-sdk-tools#5608 See [eng/common workflow](https://github.com/Azure/azure-sdk-tools/blob/main/eng/common/README.md#workflow) --------- Co-authored-by: Konrad Jamrozik <kojamroz@microsoft.com>

update the version and changelog update api update api view fix tests [engsys] Upgrade dev dependency `dotenv` version to `^16.0.0` for selected packages (#24020) Update eng/common/scripts/get-codeowners.ps1 Update get-codeowners.ps1 update Sync eng/common directory with azure-sdk-tools for PR 5608 (#25133) Sync eng/common directory with azure-sdk-tools for PR Azure/azure-sdk-tools#5608 See [eng/common workflow](https://github.com/Azure/azure-sdk-tools/blob/main/eng/common/README.md#workflow) --------- Co-authored-by: Konrad Jamrozik <kojamroz@microsoft.com> update changelog Update eng/common/scripts/get-codeowners.ps1 update update

konrad-jamrozik added the Central-EngSys This issue is owned by the Engineering System team. label Mar 2, 2023

konrad-jamrozik self-assigned this Mar 2, 2023

konrad-jamrozik requested review from weshaggard, benbp and a team March 2, 2023 23:29

konrad-jamrozik force-pushed the users/kojamroz/get_co_ps1_common_tests branch 2 times, most recently from 1ed0a49 to 3d46d04 Compare March 2, 2023 23:33

konrad-jamrozik marked this pull request as ready for review March 2, 2023 23:36

konrad-jamrozik marked this pull request as draft March 2, 2023 23:54

weshaggard reviewed Mar 3, 2023

View reviewed changes

eng/common-tests/ci.yml Show resolved Hide resolved

weshaggard reviewed Mar 3, 2023

View reviewed changes

eng/common/pipelines/templates/stages/archetype-sdk-tool-pwsh.yml Outdated Show resolved Hide resolved

konrad-jamrozik force-pushed the users/kojamroz/get_co_ps1_common_tests branch from 6b93176 to 01c5f86 Compare March 3, 2023 17:37

konrad-jamrozik marked this pull request as ready for review March 3, 2023 17:52

konrad-jamrozik requested a review from weshaggard March 3, 2023 17:52

weshaggard reviewed Mar 3, 2023

View reviewed changes

eng/common/scripts/get-codeowners/get-codeowners.ps1 Outdated Show resolved Hide resolved

konrad-jamrozik changed the title ~~Move get-codeowners test mode to common-tests~~ Move get-codeowners test mode to common-tests + related improvements & cleanup Mar 3, 2023

konrad-jamrozik changed the title ~~Move get-codeowners test mode to common-tests + related improvements & cleanup~~ Move get-codeowners.ps1 test mode to common-tests + related improvements & cleanup Mar 3, 2023

konrad-jamrozik force-pushed the users/kojamroz/get_co_ps1_common_tests branch from 0b0867d to 576805b Compare March 6, 2023 20:35

weshaggard reviewed Mar 6, 2023

View reviewed changes

eng/common-tests/get-codeowners/get-codeowners.tests.ps1 Outdated Show resolved Hide resolved

Konrad Jamrozik added 16 commits March 30, 2023 22:47

address PR remarks

8af165e

update .sln file

1168816

fix var naming + indentation

8bc8dd0

create public instance of tools - eng-common-tests and point README t…

6f06b78

…o it

Delete definition for the redundant, internal `tools - eng-script-tes…

a514e97

…ts` pipeline

revert ci.yml deletion

7710117

fix missing build step

31d42dd

Fix CodeOwnerFileLocation path, fix casing, and dedup param defaults

bfb0ede

fix param names

d842205

add todos on needed changes in cpp repo

7a1de0f

Add CodeownersFileLocation to Get-Codeowners and use $null for defaul…

39df443

…t param values

move get-codeowners back to scripts/ and rename -functions to .lib

aa515a5

fix: use empty string as defaults instead of $nulls, to fix invocation

d419134

fix bug with invocation of Get-Codeowners + add support for passing I…

d78804d

…ncludeNonUserAliases as switch

fix path iin Metadata-Helpers.ps1

8bc73d5

fix typo

ffd9eed

konrad-jamrozik force-pushed the users/kojamroz/get_co_ps1_common_tests branch from 6bf6d2c to ffd9eed Compare March 31, 2023 05:47

konrad-jamrozik mentioned this pull request Mar 31, 2023

Have a dedicated pipeline for running tests in /eng/scripts/ + fix naming convention #5878

Open

azure-sdk added the auto-merge label Mar 31, 2023

ghost merged commit b5cb2ed into main Mar 31, 2023

ghost deleted the users/kojamroz/get_co_ps1_common_tests branch March 31, 2023 06:57

benbp mentioned this pull request Apr 12, 2023

Add common engsys breaking changes doc #5938

Merged

konrad-jamrozik mentioned this pull request Apr 13, 2023

kojamroz contributions summary 11/21/2022 - 4/14/2023 #5974

Closed

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move `get-codeowners.ps1` test mode to `common-tests` + related improvements & cleanup #5608

Move `get-codeowners.ps1` test mode to `common-tests` + related improvements & cleanup #5608

konrad-jamrozik commented Mar 2, 2023 •

edited

Loading

azure-sdk commented Mar 2, 2023

azure-sdk commented Mar 2, 2023

azure-sdk commented Mar 3, 2023

azure-sdk commented Mar 3, 2023

azure-sdk commented Mar 3, 2023

azure-sdk commented Mar 3, 2023

weshaggard Mar 3, 2023

konrad-jamrozik Mar 3, 2023 •

edited

Loading

weshaggard Mar 3, 2023

konrad-jamrozik Mar 3, 2023

konrad-jamrozik Mar 3, 2023 •

edited

Loading

weshaggard Mar 3, 2023

konrad-jamrozik Mar 3, 2023 •

edited

Loading

konrad-jamrozik Mar 7, 2023

konrad-jamrozik Mar 31, 2023

azure-sdk commented Mar 3, 2023

azure-sdk commented Mar 3, 2023

azure-sdk commented Mar 3, 2023

azure-sdk commented Mar 6, 2023

azure-sdk commented Mar 31, 2023

ghost commented Mar 31, 2023


		## When tests in this directory are executed

		The PowerShell Pester unit tests will be executed by the [`tools - eng-common-tests`](https://dev.azure.com/azure-sdk/internal/_build/results?buildId=220791) pipeline

Move get-codeowners.ps1 test mode to common-tests + related improvements & cleanup #5608

Move get-codeowners.ps1 test mode to common-tests + related improvements & cleanup #5608

Conversation

konrad-jamrozik commented Mar 2, 2023 • edited Loading

azure-sdk commented Mar 2, 2023

azure-sdk commented Mar 2, 2023

azure-sdk commented Mar 3, 2023

azure-sdk commented Mar 3, 2023

azure-sdk commented Mar 3, 2023

azure-sdk commented Mar 3, 2023

weshaggard Mar 3, 2023

Choose a reason for hiding this comment

konrad-jamrozik Mar 3, 2023 • edited Loading

Choose a reason for hiding this comment

weshaggard Mar 3, 2023

Choose a reason for hiding this comment

konrad-jamrozik Mar 3, 2023

Choose a reason for hiding this comment

konrad-jamrozik Mar 3, 2023 • edited Loading

Choose a reason for hiding this comment

weshaggard Mar 3, 2023

Choose a reason for hiding this comment

konrad-jamrozik Mar 3, 2023 • edited Loading

Choose a reason for hiding this comment

konrad-jamrozik Mar 7, 2023

Choose a reason for hiding this comment

1. PowerShell test pipeline setup

2. PowerShell file naming conventions

konrad-jamrozik Mar 31, 2023

Choose a reason for hiding this comment

azure-sdk commented Mar 3, 2023

azure-sdk commented Mar 3, 2023

azure-sdk commented Mar 3, 2023

azure-sdk commented Mar 6, 2023

azure-sdk commented Mar 31, 2023

ghost commented Mar 31, 2023

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

Move `get-codeowners.ps1` test mode to `common-tests` + related improvements & cleanup #5608

Move `get-codeowners.ps1` test mode to `common-tests` + related improvements & cleanup #5608

konrad-jamrozik commented Mar 2, 2023 •

edited

Loading

konrad-jamrozik Mar 3, 2023 •

edited

Loading

konrad-jamrozik Mar 3, 2023 •

edited

Loading

konrad-jamrozik Mar 3, 2023 •

edited

Loading

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.