feat: create FOASCLI sunset diff command

[lovisaberggren]

Proposed changes

Adds new command to FOASCLI to list all endpoints with sunset date drifts between two OpenAPI specs. This can be used to check the diff in sunset dates for specific endpoints of a specific version, between OASes on different branches/envs for example.

The check will output an endpoint if the sunset dates are different, but also when the sunset date is present in one spec and not the other.

Usage:

./foascli sunset diff --spec oas-test.json --base oas.json

Example output:

[
  {
    "http_method": "GET",
    "path": "/api/atlas/v2/example/info",
    "version": "2023-01-01",
    "base_sunset_date": "2099-06-01",
    "spec_sunset_date": "2099-06-02",
    "team": "apix"
  },
  {
    "http_method": "GET",
    "path": "/api/atlas/v2/groups/{groupId}/clusters",
    "version": "2023-02-01",
    "base_sunset_date": "2027-07-02",
    "spec_sunset_date": "2027-07-01",
    "team": "Atlas Dedicated"
  },
  {
    "http_method": "GET",
    "path": "/api/atlas/v2/groups/{groupId}/clusters",
    "version": "2023-01-01",
    "base_sunset_date": "2027-07-02",
    "spec_sunset_date": "2027-07-01",
    "team": "Atlas Dedicated"
  },
  {
    "http_method": "POST",
    "path": "/api/atlas/v2/groups/{groupId}/clusters",
    "version": "2023-01-01",
    "base_sunset_date": "",
    "spec_sunset_date": "2027-07-01",
    "team": "Atlas Dedicated"
  },
  {
    "http_method": "GET",
    "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}",
    "version": "2024-08-05",
    "base_sunset_date": "2027-03-01",
    "spec_sunset_date": "",
    "team": "Atlas Dedicated"
  }
]

Jira ticket: CLOUDP-391734

Testing

Added go tests for the new command, and tested manually with two specs as well.

Follow-up

Add a GH action check to run once a day, checking the sunset diffs between dev and QA/prod OASes. In case of a diff, open a ticket and link a runbook entry for the action.

[andreaangiolillo]

could we also include the base and and target spec file name? I think it would be a useful info to see

[lovisaberggren]

Done, added to output diff, example:

[
  {
    "http_method": "GET",
    "path": "/api/atlas/v2/groups/{groupId}/serverless",
    "version": "2023-01-01",
    "base_sunset_date": "2027-01-15",
    "spec_sunset_date": "2027-01-18",
    "base_spec": "../../../openapi/.raw/v2.json",
    "spec": "../../../openapi/.raw/v2-qa.json",
    "team": "Atlas Clusters Security III"
  },
  {
    "http_method": "GET",
    "path": "/api/atlas/v2/groups/{groupId}/serverless/{name}",
    "version": "2023-01-01",
    "base_sunset_date": "2027-01-15",
    "spec_sunset_date": "2027-01-18",
    "base_spec": "../../../openapi/.raw/v2.json",
    "spec": "../../../openapi/.raw/v2-qa.json",
    "team": "Atlas Clusters Security III"
  },
]

[andreaangiolillo]

This looks more like an e2e test than a unit test. Typically, unit tests live in a _test file alongside the command they're testing. Could you move this to the e2e folder?

That said, I don't think an e2e test is necessary here; unit tests should be sufficient. The added benefit is that you won't need to include a large file in the test data folder either

[lovisaberggren]

I see, thanks! I'll move it to the e2e folder since we have it, and add some unit tests. Let me know what you think

[andreaangiolillo]

LGTM