Context

Addressing #5951. More details can be found in the issue discussion, but as a quick summary:

• argo repo get <repo> and /api/v1/repositories/{repo} are documented as Get a **configured** repository by URL.
• However, Get() Repository does not return an error when querying a repo that is not configured in Argo.
• Instead, it initializes an empty repository object, and tests the connectivity: errors returned to the user only come from the connectivity test.

In particular, Get() Repository relies on this db.getRepository. However, this function returns a valid repository object when no configured repository is found, rather than nil with an error. This contrasts with db.DeleteRepository that does return an error for unconfigured repositories

Change

db.GetRepository is called in different places, so I decided to avoid touching it, and instead implement a new db.RepositoryExists function that returns whether a repository matching the query is configured in Argo.

I then called this function from Get() Repository and propagated a codes.NotFound error as appropriate.

Alternatives

I thought about a couple of alternative implementations, let me know if an approach is preferred:

• Modifying db.GetRepository to return an error when a repository is not found, rather than an empty repository object. This would need to be done carefully to avoid breaking things for logic that relies on that current behavior of db.GetRepository. A few approaches I can think about:
  • Adding a default parameter to db.GetRepository that would be the default return value if no repository is found
  • Moving the default empty repository initialization outside of db.GetRepository to every call site when repo == nil && err == nil
• Keep the existing logic, but add a new field in the repository object to identify whether a repository is configured in Argo
• Keep the existing logic without any change, but update the documentation to correctly reflect the expectation (basically, change the Get a **configured** repository by URL).

Testing

Manual Testing

Configured Repo (API):

$ curl -s -H "Authorization: Bearer $ARGOCD_TOKEN" -k http://localhost:8080/api/v1/repositories/https%3A%2F%2Fgithub.com%2Fcylix%2Fcpp_redis | jq

{
  "repo": "https://github.com/cylix/cpp_redis",
  "connectionState": {
    "status": "Successful",
    "message": "",
    "attemptedAt": "2021-10-26T05:41:17Z"
  },
  "type": "git",
  "project": "default"
}

Configured Repo (CLI):

$ argocd --server localhost:8080 --plaintext --grpc-web repo get https://github.com/cylix/cpp_redis
TYPE  NAME  REPO                                INSECURE  OCI    LFS    CREDS  STATUS      MESSAGE
git         https://github.com/cylix/cpp_redis  false     false  false  false  Successful

Unconfigured Repo (API):

$ curl -s -H "Authorization: Bearer $ARGOCD_TOKEN" -k http://localhost:8080/api/v1/repositories/https%3A%2F%2Fgithub.com%2Ffoo%2Fexample-project.git | jq

{
  "error": "repo 'https://github.com/foo/example-project.git' not found",
  "code": 5,
  "message": "repo 'https://github.com/foo/example-project.git' not found"
}

$ curl -s -H "Authorization: Bearer $ARGOCD_TOKEN" -k http://localhost:8080/api/v1/repositories/https%3A%2F%2Fgitlab.com%2Ffoo%2Fexample-project.git | jq

{
  "error": "repo 'https://gitlab.com/foo/example-project.git' not found",
  "code": 5,
  "message": "repo 'https://gitlab.com/foo/example-project.git' not found"
}

curl -s -H "Authorization: Bearer $ARGOCD_TOKEN" -k http://localhost:8080/api/v1/repositories/git%40gitlab.com%3Afoo%2Fexample-project.git | jq

{
  "error": "repo 'git@gitlab.com:foo/example-project.git' not found",
  "code": 5,
  "message": "repo 'git@gitlab.com:foo/example-project.git' not found"
}

Unconfigured Repo (CLI):

$ argocd --server localhost:8080 --plaintext --grpc-web repo get https://github.com/foo/example-project.git
FATA[0000] rpc error: code = NotFound desc = repo 'https://github.com/foo/example-project.git' not found

Unit Tests

Added unit tests coverage ✅

Checklist

• Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
• The title of the PR states what changed and the related issues number (used for the release note).
• I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
• I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
• Does this PR require documentation updates?
• I've updated documentation as required by this PR.
• Optional. My organization is added to USERS.md.
• I have signed off all my commits as required by DCO
• I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
• My build is green (troubleshooting builds).

Misc.

Fixes #5951