Tag .NET tests

[ford-at-aws]

User story

As a code example engineer (internal) or customer (external), I want to be able to run a subset of SDK code example tests by running a generic command with a tag, i.e. <test-command> <tag>

You could accomplish this in a few different ways:

• a bash script that tags a tag parameter, e.g. ./test.sh <tag>
• a language test framework command using an include tag: dotnet test --tag @integ @unit
• the same framework as above but with an exclusion tag: dotnet test --tag ~@integ

Which tests should I tag?

You can decide this for yourself! Just make sure your own tagging strategy that allows you to isolate tests that are:

• are automation-friendly
• can run consistently without error.

What is "automation-friendly"?

This refers to tests are can be executed remotely in an Isengard account with no previous setup required. This would include both unit tests and integration tests.

What does "without error" mean?

It means you can run the test in the presence of AWS credentials from our local CLI environment and it will pass without error consistently.

Acceptance criteria

I know this is done when:

• I can pass a string tag value to my tests to invoke a subset of tests with that tag.

Tags used for tests

• [Trait("Category", "Integration")] - Integration tests
• [Trait("Category", "Unit")] - Unit tests
• [Trait("Category", "Quarantine")] - Quarantined tests that shouldn't be run automatically.

Services with Tests

• Aurora
• Autoscaling - needs tagging and conversion to XUnit.
• CloudWatch -- properly tagged
• Cognito -- properly tagged, separate PR
• DynamoDB -- scenarios
• EC2
• Glue -- properly tagged, separate PR
• IAM -- scenarios
• Keyspaces
• Lambda -- scenario
• RDS
• Route 53 -- has tests, tests properly tagged
• S3 -- scenarios have tests that need tagging
• SES -- has tests that need tagging
• Support -- has tests, needs tags
• Transcribe -- has tests, needs tags

Services with No Tests

• ACM
• CloudWatchLogs
• Comprehend
• EventBridge
• Glacier
• KMS
• Kinesis
• Organizations
• Polly
• Rekognition
• SNS
• SQS
• STS
• SecretsManager
• Translate

Cross-service Tests

• Aurora Item Tracker
• DynamoDB Item Tracker
• PhotoAnalyzer App - no tests
• SubscribePublishTranslate - no tests

Bonus points for:

• exclusion tags (e.g. ~@quarantine) -- [Trait("Category", "Quarantine")]
• multiple tags at once (e.g. @integ @unit)

Output

• Tag a story with 'integration' and 'unit', or tag a test in a story that doesn't work with 'quarantine'

[github-actions]

Marked stale by the Shirriff. Notifying @awsdocs/aws-sdk-docs-code-maintainers