Add template to merge multiple subscription configurations by benbp · Pull Request #1560 · Azure/azure-sdk-tools

benbp · 2021-04-15T18:37:04Z

This PR adds a new step that will merge multiple subscription configuration objects (initially sourced as json from keyvault via devops variable groups), and output a single object as a devops variable. This will allow service owners to manage additional subscription configurations independent of the ones we maintain. For example, the communication service has the need for their own config to store strings that vary per-cloud (e.g. static testing phone number assets and connection strings), but that also must be combined with our base configs. Right now we have to keep a separate config that, since it contains our testing principal, only the azure sdk engsys team has access to. Making it easier to maintain multiple configurations will reduce our config duplication, and also lay groundwork for keeping access credential configs separate from cloud configs for environment variables and arm template parameters.

The usage in the live.tests.yml files changes slightly to:

      - template: /eng/common/TestResources/build-test-resource-config.yml
        parameters:
          SubscriptionConfiguration: ${{ parameters.CloudConfig.SubscriptionConfiguration }}

      - template: /eng/common/TestResources/deploy-test-resources.yml
        parameters:
          ${{ if or(parameters.Location, parameters.CloudConfig.Location) }}:
            Location: ${{ coalesce(parameters.Location, parameters.CloudConfig.Location) }}
          ServiceDirectory: '${{ parameters.ServiceDirectory }}'
          SubscriptionConfiguration: $(SubscriptionConfiguration)
          ArmTemplateParameters: $(ArmTemplateParameters)

      ... test job stuff ...

      - template: /eng/common/TestResources/remove-test-resources.yml
        parameters:
          ServiceDirectory: '${{ parameters.ServiceDirectory }}'
          SubscriptionConfiguration: $(SubscriptionConfiguration)

The usage for a service owner tests.yml file looks like below, showing an example of both single and multiple subscription configurations for a cloud:

parameters:
  CloudConfig:
    Public:
      SubscriptionConfigurations:
        - $(sub-config-azure-test-resources)
        - $(sub-config-myservice-test-resources)
    PreProd:
      SubscriptionConfiguration: $(sub-config-myservice-preprod-test-resources)

azure-sdk · 2021-04-15T18:52:02Z

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 · 2021-04-16T00:07: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 · 2021-04-16T20:20:06Z

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 · 2021-04-16T20:42:33Z

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

benbp · 2021-04-16T20:48:26Z

Passing test with normal SubscriptionConfiguration (i.e. regression against no config changes): https://dev.azure.com/azure-sdk/internal/_build/results?buildId=847788&view=logs&j=68082d65-ebf7-5f3f-494d-d3fd09e80dd6

Test using new config merging: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=847902&view=results

eng/common/TestResources/build-test-resource-config.yml

weshaggard · 2021-04-16T21:01:05Z

eng/common/TestResources/build-test-resource-config.yml

+          '@ | ConvertFrom-Json -AsHashtable
+
+          foreach ($pair in $addToConfig.GetEnumerator()) {
+            if ($pair.Value -is [Hashtable]) {


This assumes only one level of nesting is that safe to assume?

Technically, someone could update a config they manage to contain more levels of nesting, but it would be ignored by all our scripts anyway, since we explicitly only look for EnvironmentVariablers and ArmTemplateParameters.

It may be helpful to publish a json schema somewhere for authors of subscription configs. I'm planning on writing a big doc next week to map out all aspects of configuring multi-cloud tests, so I'll include some config schema guidance as well.

weshaggard

Left a couple comments but otherwise looks reasonable. I assume you will integrate this into use as part of another PR as I don't see those changes here.

benbp · 2021-04-16T21:05:49Z

@weshaggard yep, usage of this goes into the live.tests.yml files in the language repos. It will include the addition of the template:

      - template: /eng/common/TestResources/build-test-resource-config.yml
        parameters:
          SubscriptionConfiguration: ${{ parameters.CloudConfig.SubscriptionConfiguration }}
          SubscriptionConfigurations: ${{ parameters.CloudConfig.SubscriptionConfigurations }}

As well as changing references to ${{ parameters.CloudConfig.SubscriptionConfiguration }} downstream of the template to $(SubscriptionConfiguration).

Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>

azure-sdk · 2021-04-16T21:27:36Z

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 · 2021-04-16T21:33:02Z

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

ghost · 2021-04-19T18:00:49Z

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.

benbp · 2021-04-19T19:54:58Z

/check-enforcer override

benbp requested review from danieljurek, heaths and weshaggard as code owners April 15, 2021 18:37

benbp self-assigned this Apr 15, 2021

benbp added the Central-EngSys This issue is owned by the Engineering System team. label Apr 15, 2021

heaths approved these changes Apr 15, 2021

View reviewed changes

Add template to merge multiple subscription configurations

64bb8cd

weshaggard reviewed Apr 16, 2021

View reviewed changes

eng/common/TestResources/build-test-resource-config.yml Outdated Show resolved Hide resolved

weshaggard reviewed Apr 16, 2021

View reviewed changes

weshaggard approved these changes Apr 16, 2021

View reviewed changes

Update eng/common/TestResources/build-test-resource-config.yml

b3bdab2

Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>

azure-sdk added the auto-merge label Apr 19, 2021

benbp merged commit dd7d2ba into Azure:master Apr 19, 2021

benbp deleted the benbp/merge-multiple-sub-configs branch April 19, 2021 19:55

Conversation

benbp commented Apr 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azure-sdk commented Apr 15, 2021

Uh oh!

azure-sdk commented Apr 16, 2021

Uh oh!

azure-sdk commented Apr 16, 2021

Uh oh!

azure-sdk commented Apr 16, 2021

Uh oh!

benbp commented Apr 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

weshaggard Apr 16, 2021

Choose a reason for hiding this comment

Uh oh!

benbp Apr 16, 2021

Choose a reason for hiding this comment

Uh oh!

weshaggard left a comment

Choose a reason for hiding this comment

Uh oh!

benbp commented Apr 16, 2021

Uh oh!

azure-sdk commented Apr 16, 2021

Uh oh!

azure-sdk commented Apr 16, 2021

Uh oh!

ghost commented Apr 19, 2021

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.

Uh oh!

benbp commented Apr 19, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

benbp commented Apr 15, 2021 •

edited

Loading

benbp commented Apr 16, 2021 •

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.