Azure/data-api-builder

Add tests to check staleness of checked-in reference config files

Open

#1,766 opened on Oct 2, 2023

View on GitHubContributor guide
 (4 comments) (0 reactions) (1 assignee)C# (348 forks)auto 404
good first issuehas-pr

Repository metrics

Stars
 (1,459 stars)
PR merge metrics
 (PR metrics pending)

Description

There are a few reference config files checked-in in the Service.Tests directory. Whenever there is a change in the way CLI generates a config file, these reference config file needs to be updated to reflect the latest changes.

At the moment, there is no validation to ensure that these reference files are as per the latest format. So, these config files tends to go out of date.

Hence, add tests to ensure that these reference config files stay up to date.

Contributor guide

Research direction
Locate the reference config files in the Service.Tests directory. Identify how config files are generated by the CLI. Write tests that generate fresh config files and compare them against the checked in references to detect staleness.
Tech stack
csharp
Domain
testing
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75