GraphQL - Expose client queries (#1941)

* expose artifact and builder query Signed-off-by: pxp928 <parth.psu@gmail.com> * add certifybad, certifygood query Signed-off-by: pxp928 <parth.psu@gmail.com> * add certifylegal client query Signed-off-by: pxp928 <parth.psu@gmail.com> * add certifyscorecard and vex client query Signed-off-by: pxp928 <parth.psu@gmail.com> * add point of contact and hashEqual client query Signed-off-by: pxp928 <parth.psu@gmail.com> * add hasSourceAt and isDep client query Signed-off-by: pxp928 <parth.psu@gmail.com> * add occur and license client query Signed-off-by: pxp928 <parth.psu@gmail.com> * add hasMetadata client query Signed-off-by: pxp928 <parth.psu@gmail.com> * add pkgEqual. vulnEqual and vulnMetadata client query Signed-off-by: pxp928 <parth.psu@gmail.com> * fix naming for client query Signed-off-by: pxp928 <parth.psu@gmail.com> * update pull request template to add graphQL client check Signed-off-by: pxp928 <parth.psu@gmail.com> --------- Signed-off-by: pxp928 <parth.psu@gmail.com>
guacsec · Jun 4, 2024 · 089496d · 089496d
1 parent e3e0f93
commit 089496d
Show file tree

Hide file tree

Showing 21 changed files with 24,047 additions and 16,285 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -9,6 +9,7 @@
 - [ ] All commits have [a Developer Certificate of Origin (DCO)](https://wiki.linuxfoundation.org/dco) -- they are generated using `-s` flag to `git commit`.
 - [ ] All new changes are covered by tests
 - [ ] If GraphQL schema is changed, `make generate` has been run
+- [ ] If GraphQL schema is changed, GraphQL client updates/additions have been made
 - [ ] If OpenAPI spec is changed, `make generate` has been run
 - [ ] If `collectsub` protobuf has been changed, `make proto` has been run
 - [ ] All CI checks are passing (tests and formatting)

diff --git a/cmd/guacone/cmd/bad.go b/cmd/guacone/cmd/bad.go
@@ -60,12 +60,12 @@ var queryBadCmd = &cobra.Command{
 		httpClient := http.Client{Transport: cli.HTTPHeaderTransport(ctx, opts.headerFile, http.DefaultTransport)}
 		gqlclient := graphql.NewClient(opts.graphqlEndpoint, &httpClient)
 
-		certifyBadResponse, err := model.CertifyBads(ctx, gqlclient, model.CertifyBadSpec{})
+		certifyBadResponse, err := model.CertifyBad(ctx, gqlclient, model.CertifyBadSpec{})
 		if err != nil {
 			logger.Fatalf("error querying for package: %v", err)
 		}
 
-		mapCertifyBad := map[string][]model.CertifyBadsCertifyBad{}
+		mapCertifyBad := map[string][]model.CertifyBadCertifyBad{}
 		for _, certifyBad := range certifyBadResponse.CertifyBad {
 			switch subject := certifyBad.Subject.(type) {
 			case *model.AllCertifyBadSubjectPackage:

diff --git a/pkg/assembler/clients/generated/operations.go b/pkg/assembler/clients/generated/operations.go
diff --git a/pkg/assembler/clients/operations/artifact.graphql b/pkg/assembler/clients/operations/artifact.graphql
@@ -34,3 +34,20 @@ query Artifacts($filter: ArtifactSpec!) {
     ...AllArtifactTree
   }
 }
+
+query ArtifactsList($filter: ArtifactSpec!, $after: ID, $first: Int) {
+  artifactsList(artifactSpec: $filter, after: $after, first: $first) {
+    totalCount
+    edges {
+      cursor
+      node {
+        ...AllArtifactTree
+      }
+    }
+    pageInfo {
+      startCursor
+      endCursor
+      hasNextPage
+    }
+  }
+}
diff --git a/pkg/assembler/clients/operations/builder.graphql b/pkg/assembler/clients/operations/builder.graphql
@@ -26,3 +26,29 @@ mutation IngestBuilder($builder: IDorBuilderInput!) {
 mutation IngestBuilders($builders: [IDorBuilderInput!]!) {
   ingestBuilders(builders: $builders)
 }
+
+
+# Exposes GraphQL queries to retrieve GUAC builders
+
+query Builders($filter: BuilderSpec!) {
+  builders(builderSpec: $filter) {
+    ...AllBuilderTree
+  }
+}
+
+query BuildersList($filter: BuilderSpec!, $after: ID, $first: Int) {
+  buildersList(builderSpec: $filter, after: $after, first: $first) {
+    totalCount
+    edges {
+      cursor
+      node {
+        ...AllBuilderTree
+      }
+    }
+    pageInfo {
+      startCursor
+      endCursor
+      hasNextPage
+    }
+  }
+}
diff --git a/pkg/assembler/clients/operations/certifyBad.graphql b/pkg/assembler/clients/operations/certifyBad.graphql
@@ -89,8 +89,25 @@ mutation IngestCertifyBadArtifacts(
 
 # Exposes GraphQL queries to retrieve GUAC CertifyBads
 
-query CertifyBads($filter: CertifyBadSpec!) {
+query CertifyBad($filter: CertifyBadSpec!) {
   CertifyBad(certifyBadSpec: $filter) {
     ...AllCertifyBad
   }
 }
+
+query CertifyBadList($filter: CertifyBadSpec!, $after: ID, $first: Int) {
+  CertifyBadList(certifyBadSpec: $filter, after: $after, first: $first) {
+    totalCount
+    edges {
+      cursor
+      node {
+        ...AllCertifyBad
+      }
+    }
+    pageInfo {
+      startCursor
+      endCursor
+      hasNextPage
+    }
+  }
+}
diff --git a/pkg/assembler/clients/operations/certifyGood.graphql b/pkg/assembler/clients/operations/certifyGood.graphql
@@ -86,3 +86,28 @@ mutation IngestCertifyGoodArtifacts(
     certifyGoods: $certifyGoods
   )
 }
+
+# Exposes GraphQL queries to retrieve GUAC CertifyGood
+
+query CertifyGood($filter: CertifyGoodSpec!) {
+  CertifyGood(certifyGoodSpec: $filter) {
+    ...AllCertifyGood
+  }
+}
+
+query CertifyGoodList($filter: CertifyGoodSpec!, $after: ID, $first: Int) {
+  CertifyGoodList(certifyGoodSpec: $filter, after: $after, first: $first) {
+    totalCount
+    edges {
+      cursor
+      node {
+        ...AllCertifyGood
+      }
+    }
+    pageInfo {
+      startCursor
+      endCursor
+      hasNextPage
+    }
+  }
+}
diff --git a/pkg/assembler/clients/operations/certifyLegal.graphql b/pkg/assembler/clients/operations/certifyLegal.graphql
@@ -33,8 +33,27 @@ mutation IngestCertifyLegalSrcs($srcs: [IDorSourceInput!]!, $declaredLicensesLis
   ingestCertifyLegals(subjects: {sources: $srcs}, declaredLicensesList: $declaredLicensesList, discoveredLicensesList: $discoveredLicensesList, certifyLegals: $legals)
 }
 
-query CertifyLegals($filter: CertifyLegalSpec!) {
+# Exposes GraphQL queries to retrieve GUAC CertifyLegal
+
+query CertifyLegal($filter: CertifyLegalSpec!) {
   CertifyLegal(certifyLegalSpec: $filter) {
     ...AllCertifyLegalTree
   }
 }
+
+query CertifyLegalList($filter: CertifyLegalSpec!, $after: ID, $first: Int) {
+  CertifyLegalList(certifyLegalSpec: $filter, after: $after, first: $first) {
+    totalCount
+    edges {
+      cursor
+      node {
+        ...AllCertifyLegalTree
+      }
+    }
+    pageInfo {
+      startCursor
+      endCursor
+      hasNextPage
+    }
+  }
+}
diff --git a/pkg/assembler/clients/operations/certifyScorecard.graphql b/pkg/assembler/clients/operations/certifyScorecard.graphql
@@ -33,8 +33,27 @@ mutation IngestCertifyScorecards(
   ingestScorecards(sources: $sources, scorecards: $scorecards)
 }
 
+# Exposes GraphQL queries to retrieve GUAC Scorecards
+
 query Scorecards($filter: CertifyScorecardSpec!) {
   scorecards(scorecardSpec: $filter) {
     ...AllCertifyScorecard
   }
 }
+
+query ScorecardsList($filter: CertifyScorecardSpec!, $after: ID, $first: Int) {
+  scorecardsList(scorecardSpec: $filter, after: $after, first: $first) {
+    totalCount
+    edges {
+      cursor
+      node {
+        ...AllCertifyScorecard
+      }
+    }
+    pageInfo {
+      startCursor
+      endCursor
+      hasNextPage
+    }
+  }
+}
diff --git a/pkg/assembler/clients/operations/certifyVEXStatement.graphql b/pkg/assembler/clients/operations/certifyVEXStatement.graphql
@@ -68,3 +68,27 @@ mutation IngestCertifyVexArtifacts(
     vexStatements: $vexStatements)
 }
 
+# Exposes GraphQL queries to retrieve GUAC VEX
+
+query VEXStatements($filter: CertifyVEXStatementSpec!) {
+  CertifyVEXStatement(certifyVEXStatementSpec: $filter) {
+    ...AllCertifyVEXStatement
+  }
+}
+
+query VEXStatementList($filter: CertifyVEXStatementSpec!, $after: ID, $first: Int) {
+  CertifyVEXStatementList(certifyVEXStatementSpec: $filter, after: $after, first: $first) {
+    totalCount
+    edges {
+      cursor
+      node {
+        ...AllCertifyVEXStatement
+      }
+    }
+    pageInfo {
+      startCursor
+      endCursor
+      hasNextPage
+    }
+  }
+}
diff --git a/pkg/assembler/clients/operations/contact.graphql b/pkg/assembler/clients/operations/contact.graphql
@@ -86,3 +86,28 @@ mutation IngestPointOfContactArtifacts(
     pointOfContacts: $pointOfContacts
   )
 }
+
+# Exposes GraphQL queries to retrieve GUAC Point of Contact
+
+query PointOfContacts($filter: PointOfContactSpec!) {
+  PointOfContact(pointOfContactSpec: $filter) {
+    ...AllPointOfContact
+  }
+}
+
+query PointOfContactList($filter: PointOfContactSpec!, $after: ID, $first: Int) {
+  PointOfContactList(pointOfContactSpec: $filter, after: $after, first: $first) {
+    totalCount
+    edges {
+      cursor
+      node {
+        ...AllPointOfContact
+      }
+    }
+    pageInfo {
+      startCursor
+      endCursor
+      hasNextPage
+    }
+  }
+}
diff --git a/pkg/assembler/clients/operations/hasSourceAt.graphql b/pkg/assembler/clients/operations/hasSourceAt.graphql
@@ -47,3 +47,28 @@ mutation IngestHasSourcesAt(
     hasSourceAts: $hasSourceAts
   )
 }
+
+# Exposes GraphQL queries to retrieve GUAC HasSourceAt
+
+query HasSourceAt($filter: HasSourceAtSpec!) {
+  HasSourceAt(hasSourceAtSpec: $filter) {
+    ...AllHasSourceAt
+  }
+}
+
+query HasSourceAtList($filter: HasSourceAtSpec!, $after: ID, $first: Int) {
+  HasSourceAtList(hasSourceAtSpec: $filter, after: $after, first: $first) {
+    totalCount
+    edges {
+      cursor
+      node {
+        ...AllHasSourceAt
+      }
+    }
+    pageInfo {
+      startCursor
+      endCursor
+      hasNextPage
+    }
+  }
+}
diff --git a/pkg/assembler/clients/operations/hashEqual.graphql b/pkg/assembler/clients/operations/hashEqual.graphql
@@ -15,12 +15,6 @@
 
 # NOTE: This is experimental and might change in the future!
 
-query HashEquals($filter: HashEqualSpec!) {
-  HashEqual(hashEqualSpec: $filter) {
-    ...AllHashEqualTree
-  }
-}
-
 # Defines the GraphQL operations to certify that two artifacts are identical
 
 mutation IngestHashEqual(
@@ -48,3 +42,28 @@ mutation IngestHashEquals(
     hashEquals: $hashEquals
   )
 }
+
+# Exposes GraphQL queries to retrieve GUAC HashEqual
+
+query HashEquals($filter: HashEqualSpec!) {
+  HashEqual(hashEqualSpec: $filter) {
+    ...AllHashEqualTree
+  }
+}
+
+query HashEqualList($filter: HashEqualSpec!, $after: ID, $first: Int) {
+  HashEqualList(hashEqualSpec: $filter, after: $after, first: $first) {
+    totalCount
+    edges {
+      cursor
+      node {
+        ...AllHashEqualTree
+      }
+    }
+    pageInfo {
+      startCursor
+      endCursor
+      hasNextPage
+    }
+  }
+}
diff --git a/pkg/assembler/clients/operations/isDependency.graphql b/pkg/assembler/clients/operations/isDependency.graphql
@@ -54,3 +54,20 @@ query Dependencies($filter: IsDependencySpec!) {
     ...AllIsDependencyTree
   }
 }
+
+query DependencyList($filter: IsDependencySpec!, $after: ID, $first: Int) {
+  IsDependencyList(isDependencySpec: $filter, after: $after, first: $first) {
+    totalCount
+    edges {
+      cursor
+      node {
+        ...AllIsDependencyTree
+      }
+    }
+    pageInfo {
+      startCursor
+      endCursor
+      hasNextPage
+    }
+  }
+}
diff --git a/pkg/assembler/clients/operations/isOccurrence.graphql b/pkg/assembler/clients/operations/isOccurrence.graphql
@@ -17,12 +17,6 @@
 
 # Defines the GraphQL operations to ingest occurrence information into GUAC
 
-query IsOccurrences($filter: IsOccurrenceSpec!) {
-  IsOccurrence(isOccurrenceSpec: $filter) {
-    ...AllIsOccurrencesTree
-  }
-}
-
 mutation IngestIsOccurrencePkg(
   $pkg: IDorPkgInput!
   $artifact: IDorArtifactInput!
@@ -72,3 +66,29 @@ mutation IngestIsOccurrencesSrc(
     occurrences: $occurrences
   )
 }
+
+# Exposes GraphQL queries to retrieve IsOccurrences
+
+query Occurrences($filter: IsOccurrenceSpec!) {
+  IsOccurrence(isOccurrenceSpec: $filter) {
+    ...AllIsOccurrencesTree
+  }
+}
+
+query OccurrenceList($filter: IsOccurrenceSpec!, $after: ID, $first: Int) {
+  IsOccurrenceList(isOccurrenceSpec: $filter, after: $after, first: $first) {
+    totalCount
+    edges {
+      cursor
+      node {
+        ...AllIsOccurrencesTree
+      }
+    }
+    pageInfo {
+      startCursor
+      endCursor
+      hasNextPage
+    }
+  }
+}
+
diff --git a/pkg/assembler/clients/operations/license.graphql b/pkg/assembler/clients/operations/license.graphql
@@ -34,3 +34,20 @@ query Licenses($filter: LicenseSpec!) {
     ...AllLicenseTree
   }
 }
+
+query LicenseList($filter: LicenseSpec!, $after: ID, $first: Int) {
+  licenseList(licenseSpec: $filter, after: $after, first: $first) {
+    totalCount
+    edges {
+      cursor
+      node {
+        ...AllLicenseTree
+      }
+    }
+    pageInfo {
+      startCursor
+      endCursor
+      hasNextPage
+    }
+  }
+}