feat: Support Code Security Configurations API by maditya · Pull Request #3319 · google/go-github

maditya · 2024-10-09T19:35:53Z

This PR implements Code Security Configurations APIs as defined at https://docs.github.com/en/rest/code-security/configurations?apiVersion=2022-11-28

Fixes#3211

google-cla · 2024-10-09T19:35:58Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

This PR implements Code Security Configurations APIs as defined at https://docs.github.com/en/rest/code-security/configurations?apiVersion=2022-11-28

codecov · 2024-10-09T20:20:30Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.36%. Comparing base (2b8c7fa) to head (e640711).
Report is 150 commits behind head on master.

Additional details and impacted files

@@ Coverage Diff @@## master #3319 +/- ##
==========================================
- Coverage 97.72% 93.36% -4.36% 
==========================================
Files 153 172 +19 Lines 13390 11843 -1547 ==========================================
- Hits 13085 11057 -2028 - Misses 215 692 +477 - Partials 90 94 +4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

gmlewis

Thank you, @maditya!
Just a few tweaks, and please remember to run go generate ./... as mentioned in step 4 of CONTRIBUTING.md and push (not force-push) the changes to this PR.
We then should be ready for a second LGTM+Approval from any other contributor to this repo before merging.

gmlewis · 2024-10-09T20:22:21Z

+
+// DependencyGraphAutosubmitActionOptions represents the options for the DependencyGraphAutosubmitAction.
+type DependencyGraphAutosubmitActionOptions struct {
+	LabeledRunners bool `json:"labeled_runners,omitempty"`


Suggested change
LabeledRunnersbool`json:"labeled_runners,omitempty"`
LabeledRunners*bool`json:"labeled_runners,omitempty"`

gmlewis · 2024-10-09T20:26:32Z

+// GitHub API docs: https://docs.github.com/en/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository
+//
+//meta:operation GET /repos/{owner}/{repo}/code-security-configuration
+func (s *OrganizationsService) GetCodeSecurityConfigurationForRepository(ctx context.Context, org string, repo string) (*RepositoryCodeSecurityConfiguration, *Response, error) {


Suggested change
func (s*OrganizationsService) GetCodeSecurityConfigurationForRepository(ctx context.Context, orgstring, repostring) (*RepositoryCodeSecurityConfiguration, *Response, error) {
func (s*OrganizationsService) GetCodeSecurityConfigurationForRepository(ctx context.Context, org, repostring) (*RepositoryCodeSecurityConfiguration, *Response, error) {

maditya · 2024-10-09T22:16:14Z

@gmlewis Thanks!
I tried and fixed go generate ./... which updated a bunch of other files.
But metadata script is failing -

ambiguous operation "GET /user/{user_id}" could match any of: [GET /user/{account_id} GET /user/{user_id}]
github/github.go:8: running "../script/metadata.sh": exit status 1

Any idea how to address it? Doesn't seem related to the new API.

gmlewis · 2024-10-10T01:26:55Z

Any idea how to address it?

Hmmm... a lot more files changed than I expected.
It looks like you may have locally updated the OpenAPI specs, which is typically done by a maintainer of the repo.

We have two options:

revert the changes to all the files except your original two, then run go generate ./...
wait for another PR to update all the OpenAPI stuff and fix all the errors you are seeing

I think option 1 is probably better since option 2 may take a while, and I'm currently monitoring a hurricane locally.

maditya · 2024-10-10T05:31:05Z

revert the changes to all the files except your original two, then run go generate ./...

Done. Note that go generate ./... updates some other files, namely github/admin_users.go, github/github-accessors.go and github/github-accessors_test.go and will fail until openapi_operations.yaml is updated. I get these errors:

could not find operation "GET /orgs/{org}/code-security/configurations" in openapi_operations.yaml
could not find operation "POST /orgs/{org}/code-security/configurations" in openapi_operations.yaml
could not find operation "GET /orgs/{org}/code-security/configurations/defaults" in openapi_operations.yaml
could not find operation "DELETE /orgs/{org}/code-security/configurations/detach" in openapi_operations.yaml
could not find operation "GET /orgs/{org}/code-security/configurations/{configuration_id}" in openapi_operations.yaml
could not find operation "PATCH /orgs/{org}/code-security/configurations/{configuration_id}" in openapi_operations.yaml
could not find operation "DELETE /orgs/{org}/code-security/configurations/{configuration_id}" in openapi_operations.yaml
could not find operation "POST /orgs/{org}/code-security/configurations/{configuration_id}/attach" in openapi_operations.yaml
could not find operation "PUT /orgs/{org}/code-security/configurations/{configuration_id}/defaults" in openapi_operations.yaml
could not find operation "GET /orgs/{org}/code-security/configurations/{configuration_id}/repositories" in openapi_operations.yaml
could not find operation "GET /repos/{owner}/{repo}/code-security-configuration" in openapi_operations.yaml
github/github.go:8: running "../script/metadata.sh": exit status 1

gmlewis · 2024-10-10T12:26:19Z

Note that go generate ./... updates some other files

That is really strange.
go generate ./... should only update three files (as needed):

github/github-accessors.go
github/github-accessors_test.go
github/github-stringify_test.go

I'm going to make a new branch locally with just your changes to your two files and run go generate ./... and see what happens for me and report back.

gmlewis · 2024-10-10T12:39:50Z

I'm going to make a new branch locally with just your changes to your two files and run go generate ./... and see what happens for me and report back.

Ah, I see what is going on now. You are adding support for new operations not yet defined in our local OpenAPI yaml.

This section in CONTRIBUTING.md is pertinent to you:

openapi_operations.yaml
Most contributors won't need to interact with openapi_operations.yaml, but it
may be useful to know what it is. Its sections are:
...

~~So you can either attempt to update it yourself by running script/metadata.sh update-openapi and then work out any issues you find, or I can do that in a separate PR. Which would you prefer?~~

gmlewis · 2024-10-10T12:55:04Z

EDIT: I've gone ahead and created #3322 which you should be able to merge into your PR (from master ~~once I merge it~~ EDIT: merged), which should make the rest of this PR easier to finish.

It looks like (in addition to the code generation), the tests need to have more coverage by using existing test helper methods like testBadOptions and testNewRequestAndDoFailure. You can see these in the GitHub UI.

maditya · 2024-10-10T14:40:54Z

thanks! go generate ./... works as expected now. I added remaining tests.

gmlewis

Thank you, @maditya !
LGTM.

Awaiting second LGTM+Approval from any other contributor to this repo before merging.

tomfeigin

LGTM :)

gmlewis · 2024-10-14T10:32:45Z

Thank you, @tomfeigin !
Merging.

Fixes: google#3211.

feat: Support Code Security Configurations API
c8041cd
This PR implements Code Security Configurations APIs as defined at https://docs.github.com/en/rest/code-security/configurations?apiVersion=2022-11-28

maditya force-pushed the codesecurity-config branch from 983763b to c8041cdCompare October 9, 2024 19:39

gmlewis requested changes Oct 9, 2024
View reviewed changes

gmlewis added the NeedsReview PR is awaiting a review before merging. label Oct 9, 2024

maditya added 2 commits October 9, 2024 14:51

fix lint and address comments
616133e

regenerate openapi_operations.yaml and corresponding go code
55dd303

madityaand others added 2 commits October 9, 2024 22:24

preserve changes in orgs_codesecurity_configurations only
519f47e

Merge branch 'master' into codesecurity-config
9c443ba

gmlewis mentioned this pull request Oct 10, 2024
Update openapi_operations.yaml #3322
Merged

madityaand others added 2 commits October 10, 2024 07:07

Merge branch 'master' into codesecurity-config
9f4dade

add more tests
e640711

gmlewis approved these changes Oct 10, 2024
View reviewed changes

tomfeigin approved these changes Oct 14, 2024
View reviewed changes

gmlewis removed the NeedsReview PR is awaiting a review before merging. label Oct 14, 2024

gmlewis merged commit b1615cb into google:masterOct 14, 2024

gmlewis mentioned this pull request Nov 27, 2024
Bump version of go-github to v67.0.0 #3360
Merged

jlaportebot added a commit to jlaportebot/go-github that referenced this pull request Jun 28, 2026
feat: Support Code Security Configurations API (google#3319)
5f7267b
Fixes: google#3211.

coderabbitaiBot mentioned this pull request Jul 27, 2026
Expand scraper coverage and diagnostics flanksource/config-db#2334
Open

	LabeledRunnersbool`json:"labeled_runners,omitempty"`
	LabeledRunners*bool`json:"labeled_runners,omitempty"`

	func (sOrganizationsService) GetCodeSecurityConfigurationForRepository(ctx context.Context, orgstring, repostring) (RepositoryCodeSecurityConfiguration, *Response, error) {
	func (sOrganizationsService) GetCodeSecurityConfigurationForRepository(ctx context.Context, org, repostring) (RepositoryCodeSecurityConfiguration, *Response, error) {

Uh oh!

Conversation

maditya commented Oct 9, 2024

Uh oh!

google-claBot commented Oct 9, 2024

Uh oh!

codecovBot commented Oct 9, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gmlewisOct 9, 2024

Choose a reason for hiding this comment

Uh oh!

gmlewisOct 9, 2024

Choose a reason for hiding this comment

Uh oh!

maditya commented Oct 9, 2024

Uh oh!

gmlewis commented Oct 10, 2024

Uh oh!

maditya commented Oct 10, 2024

Uh oh!

gmlewis commented Oct 10, 2024

Uh oh!

gmlewis commented Oct 10, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

openapi_operations.yaml

Uh oh!

gmlewis commented Oct 10, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

maditya commented Oct 10, 2024

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

tomfeigin left a comment

Choose a reason for hiding this comment

Uh oh!

gmlewis commented Oct 14, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecovBot commented Oct 9, 2024•
edited
Loading

gmlewis commented Oct 10, 2024•
edited
Loading

gmlewis commented Oct 10, 2024•
edited
Loading