Function TestBaseRepoQuerySelections

api/queries_repo_test.go:146–202

TestBaseRepoQuerySelections guards fields that must be explicitly requested. A field left out of a query is silently zero rather than an error, so the selection is asserted against the request instead of the response.

(t *testing.T)

// A field left out of a query is silently zero rather than an error, so the
// selection is asserted against the request instead of the response.
func TestBaseRepoQuerySelections(t *testing.T) {
	tests := []struct {
		name    string
		matcher httpmock.Matcher
		body    string
		fields  []string
		call    func(*Client) error
	}{
		{
			name:    "GitHubRepo",
			matcher: httpmock.GraphQL(`query RepositoryInfo\b`),
			body:    `{ "data": { "repository": { "id": "REPOID", "databaseId": 1234 } } }`,
			fields:  []string{"databaseId", "sshUrl"},
			call: func(client *Client) error {
				_, err := GitHubRepo(client, ghrepo.New("OWNER", "REPO"))
				return err
			},
		},
		{
			name:    "RepoNetwork",
			matcher: httpmock.GraphQL(`query RepositoryNetwork\b`),
			body:    `{ "data": { "repo_000": { "id": "REPOID", "databaseId": 1234 } } }`,
			fields:  []string{"databaseId"},
			call: func(client *Client) error {
				_, err := RepoNetwork(client, []ghrepo.Interface{ghrepo.New("OWNER", "REPO")})
				return err
			},
		},
		{
			name:    "IssueRepoInfo",
			matcher: httpmock.GraphQL(`query IssueRepositoryInfo\b`),
			body:    `{ "data": { "repository": { "id": "REPOID", "databaseId": 1234 } } }`,
			fields:  []string{"databaseId"},
			call: func(client *Client) error {
				_, err := IssueRepoInfo(client, ghrepo.New("OWNER", "REPO"))
				return err
			},
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			httpReg := &httpmock.Registry{}
			defer httpReg.Verify(t)

			var query string
			httpReg.Register(tt.matcher, httpmock.GraphQLQuery(tt.body, func(q string, _ map[string]any) {
				query = q
			}))

			require.NoError(t, tt.call(newTestClient(httpReg)))
			for _, field := range tt.fields {
				assert.Contains(t, query, field)
			}
		})
	}
}