Require the AWS region to be specified if using AWS S3 for blob storage

[timrogers]

A few months ago, we changed the CLI to allow an AWS region to be specified when using AWS S3 for blob storage in gh gei and gh bbs2gh.

We added support for specifying an AWS region because:

• Without a region, we have to default to using AWS V2 signatures, and these do not work in all regions, causing migrations to fail with a confusing error message
• You can't use AWS temporary credentials (i.e. a session token) without a region

For backwards compatibility, we made the region optional - unless you're using an AWS session token specified with --aws-session-token or AWS_SESSION_TOKEN, in which case the region is mandatory. If you don't specify it, we allow you to continue, but print a warning saying that providing a region is recommended and will soon be mandatory.

This updates the behaviour, completing our breaking change, making it mandatory to specify the session token.

• Did you write/update appropriate tests
• Release notes updated (if appropriate)
• Appropriate logging output
• Issue linked
• Docs updated (or issue created)
• New package licenses are added to ThirdPartyNotices.txt (if applicable)

[timrogers]

It doesn't seem like we should have to have this validation here because AwsApiFactory will validate that the region is set when it is initialized. But in the tests, there are some cases which skip that path and this validation gets run.

[timrogers]

Fixes #857.

[timrogers]

The tests pass for me locally, but we get failures like this in CI:

[xUnit.net 00:00:03.13]     OctoshiftCLI.Tests.GithubEnterpriseImporter.Commands.MigrateRepo.MigrateRepoCommandHandlerTests.It_Uses_Aws_If_Arguments_Are_Included [FAIL]
  Failed OctoshiftCLI.Tests.GithubEnterpriseImporter.Commands.MigrateRepo.MigrateRepoCommandHandlerTests.It_Uses_Aws_If_Arguments_Are_Included [970 ms]
  Error Message:
   Amazon.Runtime.AmazonClientException : No RegionEndpoint or ServiceURL configured
  Stack Trace:
     at Amazon.Runtime.ClientConfig.Validate()
   at Amazon.S3.AmazonS3Config.Validate()
   at Amazon.Runtime.AmazonServiceClient..ctor(AWSCredentials credentials, ClientConfig config)
   at Amazon.S3.AmazonS3Client..ctor(AWSCredentials credentials, AmazonS3Config clientConfig)
   at OctoshiftCLI.Services.AwsApi.BuildAmazonS3Client(String awsAccessKeyId, String awsSecretAccessKey, String awsRegion, String awsSessionToken) in D:\a\gh-gei\gh-gei\src\Octoshift\Services\AwsApi.cs:line 43
   at OctoshiftCLI.Services.AwsApi..ctor(String awsAccessKeyId, String awsSecretAccessKey, String awsRegion, String awsSessionToken) in D:\a\gh-gei\gh-gei\src\Octoshift\Services\AwsApi.cs:line 21
   at Castle.Proxies.AwsApiProxy..ctor(IInterceptor[] , String awsAccessKeyId, String awsSecretAccessKey, String awsRegion, String awsSessionToken)

I'm not sure how to debug that.

[github-actions]

Unit Test Results

781 tests   781 ✔️  24s ⏱️
    1 suites      0 💤
    1 files        0 ❌

Results for commit 40ef791.

♻️ This comment has been updated with latest results.

[dylan-smith]

The tests pass for me locally, but we get failures like this in CI:

[xUnit.net 00:00:03.13]     OctoshiftCLI.Tests.GithubEnterpriseImporter.Commands.MigrateRepo.MigrateRepoCommandHandlerTests.It_Uses_Aws_If_Arguments_Are_Included [FAIL]
  Failed OctoshiftCLI.Tests.GithubEnterpriseImporter.Commands.MigrateRepo.MigrateRepoCommandHandlerTests.It_Uses_Aws_If_Arguments_Are_Included [970 ms]
  Error Message:
   Amazon.Runtime.AmazonClientException : No RegionEndpoint or ServiceURL configured
  Stack Trace:
     at Amazon.Runtime.ClientConfig.Validate()
   at Amazon.S3.AmazonS3Config.Validate()
   at Amazon.Runtime.AmazonServiceClient..ctor(AWSCredentials credentials, ClientConfig config)
   at Amazon.S3.AmazonS3Client..ctor(AWSCredentials credentials, AmazonS3Config clientConfig)
   at OctoshiftCLI.Services.AwsApi.BuildAmazonS3Client(String awsAccessKeyId, String awsSecretAccessKey, String awsRegion, String awsSessionToken) in D:\a\gh-gei\gh-gei\src\Octoshift\Services\AwsApi.cs:line 43
   at OctoshiftCLI.Services.AwsApi..ctor(String awsAccessKeyId, String awsSecretAccessKey, String awsRegion, String awsSessionToken) in D:\a\gh-gei\gh-gei\src\Octoshift\Services\AwsApi.cs:line 21
   at Castle.Proxies.AwsApiProxy..ctor(IInterceptor[] , String awsAccessKeyId, String awsSecretAccessKey, String awsRegion, String awsSessionToken)

I'm not sure how to debug that.

When I run it in a codespace I see the same failing tests. You might not be seeing it locally because you have some AWS env vars set that the CI doesn't?

[timrogers]

That's a great point. I definitely do. I'll give it a go on a Codespace on Monday. Another reason why clean, separated environments are a good idea...!

[github-actions]

Package	Line Rate	Branch Rate	Complexity	Health
Octoshift	85%	75%	1205	✔
bbs2gh	79%	75%	638	✔
ado2gh	84%	82%	617	✔
gei	80%	75%	520	✔
Summary	83% (6532 / 7856)	77% (1526 / 1992)	2980	✔

[synthead]

LGTM!