Azure / Azure/data-api-builder

Improve readability and extensibility in the test suite

Open
#2,143 1 comment 0 reactions 1 assignee Claimed by @aaronburtle View on GitHub
cleanup test
Dominant language
C#
Stars
1.5k
Forks
370
Avg merge
3d 17h
Merged PRs (30d)
8

Description

Across our test suite, we have a number of tests that have correct functionality but can be difficult to modify and have some readability issues. Things like code duplication, and hard coded values can make updates to the test time consuming.

As an example, take this test from `GraphQLPaginationTests.RequestAfterTokenOnly`

![image](https://github.com/Azure/data-api-builder/assets/93220300/1829fe7d-14b9-46a4-94cc-5d9f282ad99d)

Because of how the expected values are coded, if for example we want to update this test because we have a case where the after token is not of this form, it requires us to add another conditional that matches the new case and then has the expected value setup their. This is difficult to read, and slow to update.

As we expand our functionality we will require updates to our test suite, and improving readability and extensibility will be useful.

One candidate for code duplication is the test class used in this PR

https://github.com/Azure/data-api-builder/pull/2139

which has many spots where code is duplicated across many tests.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.