add CodeIssue check type (#470)

davidbloss · web-flow · commit b7f5d590a6f3 · 2024-10-24T14:39:06.000-05:00
* add CodeIssue check type, more robust check testing

* remove redundant assertions in check test

* add CodeIssueCheckFragment, update struct docs and tests

* fix types of fields in CodeIssueCheck

* add CodeIssueCheck structs and tests

* remove unneeded pointers
diff --git a/.changes/unreleased/Feature-20241004-123207.yaml b/.changes/unreleased/Feature-20241004-123207.yaml
@@ -0,0 +1,3 @@
+kind: Feature
+body: add CodeIssue check type
+time: 2024-10-04T12:32:07.226978-05:00
diff --git a/check.go b/check.go
@@ -19,6 +19,7 @@ type CheckInputConstructor func() any
 
 var CheckCreateConstructors = map[CheckType]CheckInputConstructor{
 	CheckTypeAlertSourceUsage:    func() any { return &CheckAlertSourceUsageCreateInput{} },
+	CheckTypeCodeIssue:           func() any { return &CheckCodeIssueCreateInput{} },
 	CheckTypeCustom:              func() any { return &CheckCreateInput{} },
 	CheckTypeGeneric:             func() any { return &CheckCustomEventCreateInput{} },
 	CheckTypeGitBranchProtection: func() any { return &CheckGitBranchProtectionCreateInput{} },
@@ -41,6 +42,7 @@ var CheckCreateConstructors = map[CheckType]CheckInputConstructor{
 
 var CheckUpdateConstructors = map[CheckType]CheckInputConstructor{
 	CheckTypeAlertSourceUsage:    func() any { return &CheckAlertSourceUsageUpdateInput{} },
+	CheckTypeCodeIssue:           func() any { return &CheckCodeIssueUpdateInput{} },
 	CheckTypeCustom:              func() any { return &CheckUpdateInput{} },
 	CheckTypeGeneric:             func() any { return &CheckCustomEventUpdateInput{} },
 	CheckTypeGitBranchProtection: func() any { return &CheckGitBranchProtectionUpdateInput{} },
@@ -140,6 +142,8 @@ func (client *Client) CreateCheck(input any) (*Check, error) {
 	switch v := input.(type) {
 	case *CheckAlertSourceUsageCreateInput:
 		return client.CreateCheckAlertSourceUsage(*v)
+	case *CheckCodeIssueCreateInput:
+		return client.CreateCheckCodeIssue(*v)
 	case *CheckCustomEventCreateInput:
 		return client.CreateCheckCustomEvent(*v)
 	case *CheckGitBranchProtectionCreateInput:
@@ -226,6 +230,8 @@ func (client *Client) UpdateCheck(input any) (*Check, error) {
 	switch v := input.(type) {
 	case *CheckAlertSourceUsageUpdateInput:
 		return client.UpdateCheckAlertSourceUsage(*v)
+	case *CheckCodeIssueUpdateInput:
+		return client.UpdateCheckCodeIssue(*v)
 	case *CheckCustomEventUpdateInput:
 		return client.UpdateCheckCustomEvent(*v)
 	case *CheckGitBranchProtectionUpdateInput:
diff --git a/check_alert_source_usage.go b/check_alert_source_usage.go
@@ -1,8 +1,8 @@
 package opslevel
 
 type AlertSourceUsageCheckFragment struct {
-	AlertSourceNamePredicate *Predicate          `graphql:"alertSourceNamePredicate"`
-	AlertSourceType          AlertSourceTypeEnum `graphql:"alertSourceType"`
+	AlertSourceNamePredicate *Predicate          `graphql:"alertSourceNamePredicate"` // The condition that the alert source name should satisfy to be evaluated.
+	AlertSourceType          AlertSourceTypeEnum `graphql:"alertSourceType"`          // The type of the alert source.
 }
 
 func (client *Client) CreateCheckAlertSourceUsage(input CheckAlertSourceUsageCreateInput) (*Check, error) {
diff --git a/check_code_issue.go b/check_code_issue.go
@@ -0,0 +1,38 @@
+package opslevel
+
+type CodeIssueCheckFragment struct {
+	Constraint     CheckCodeIssueConstraintEnum `graphql:"constraint"`     // The type of constraint used in evaluation the code issues check.
+	IssueName      string                       `graphql:"issueName"`      // The issue name used for code issue lookup.
+	IssueType      []string                     `graphql:"issueType"`      // The type of code issue to consider.
+	MaxAllowed     int                          `graphql:"maxAllowed"`     // The threshold count of code issues beyond which the check starts failing.
+	ResolutionTime CodeIssueResolutionTime      `graphql:"resolutionTime"` // The resolution time recommended by the reporting source of the code issue.
+	Severity       []string                     `graphql:"severity"`       // The severity levels of the issue.
+}
+
+// CodeIssueResolutionTime represents how long a code issue has been detected.
+type CodeIssueResolutionTime struct {
+	Unit  CodeIssueResolutionTimeUnitEnum `graphql:"unit"`  // The name of duration of time.
+	Value int                             `graphql:"value"` // The count value of the specified unit.
+}
+
+func (client *Client) CreateCheckCodeIssue(input CheckCodeIssueCreateInput) (*Check, error) {
+	var m struct {
+		Payload CheckResponsePayload `graphql:"checkCodeIssueCreate(input: $input)"`
+	}
+	v := PayloadVariables{
+		"input": input,
+	}
+	err := client.Mutate(&m, v, WithName("CheckCodeIssueCreate"))
+	return &m.Payload.Check, HandleErrors(err, m.Payload.Errors)
+}
+
+func (client *Client) UpdateCheckCodeIssue(input CheckCodeIssueUpdateInput) (*Check, error) {
+	var m struct {
+		Payload CheckResponsePayload `graphql:"checkCodeIssueUpdate(input: $input)"`
+	}
+	v := PayloadVariables{
+		"input": input,
+	}
+	err := client.Mutate(&m, v, WithName("CheckCodeIssueUpdate"))
+	return &m.Payload.Check, HandleErrors(err, m.Payload.Errors)
+}
diff --git a/check_custom_event.go b/check_custom_event.go
@@ -1,11 +1,11 @@
 package opslevel
 
 type CustomEventCheckFragment struct {
-	Integration      IntegrationId `graphql:"integration"`
-	PassPending      bool          `graphql:"passPending"`
-	ResultMessage    string        `graphql:"resultMessage"`
-	ServiceSelector  string        `graphql:"serviceSelector"`
-	SuccessCondition string        `graphql:"successCondition"`
+	Integration      IntegrationId `graphql:"integration"`      // The integration this check uses.
+	PassPending      bool          `graphql:"passPending"`      // True if this check should pass by default. Otherwise the default 'pending' state counts as a failure.
+	ResultMessage    string        `graphql:"resultMessage"`    // The check result message template.
+	ServiceSelector  string        `graphql:"serviceSelector"`  // A jq expression that will be ran against your payload to select the service.
+	SuccessCondition string        `graphql:"successCondition"` // A jq expression that will be ran against your payload to evaluate the check result. A truthy value will result in the check passing.
 }
 
 func (client *Client) CreateCheckCustomEvent(input CheckCustomEventCreateInput) (*Check, error) {
diff --git a/check_has_documentation.go b/check_has_documentation.go
@@ -1,8 +1,8 @@
 package opslevel
 
 type HasDocumentationCheckFragment struct {
-	DocumentType    HasDocumentationTypeEnum    `graphql:"documentType"`
-	DocumentSubtype HasDocumentationSubtypeEnum `graphql:"documentSubtype"`
+	DocumentSubtype HasDocumentationSubtypeEnum `graphql:"documentSubtype"` // The subtype of the document.
+	DocumentType    HasDocumentationTypeEnum    `graphql:"documentType"`    // The type of the document.
 }
 
 func (client *Client) CreateCheckHasDocumentation(input CheckHasDocumentationCreateInput) (*Check, error) {
diff --git a/check_has_owner.go b/check_has_owner.go
@@ -1,10 +1,10 @@
 package opslevel
 
 type ServiceOwnershipCheckFragment struct {
-	RequireContactMethod *bool        `graphql:"requireContactMethod"`
-	ContactMethod        *ContactType `graphql:"contactMethod"`
-	TeamTagKey           string       `graphql:"tagKey"`
-	TeamTagPredicate     *Predicate   `graphql:"tagPredicate"`
+	ContactMethod        *ContactType `graphql:"contactMethod"`        // The type of contact method that an owner should provide.
+	RequireContactMethod *bool        `graphql:"requireContactMethod"` // Whether to require a contact method for a service owner or not.
+	TeamTagKey           string       `graphql:"tagKey"`               // The tag key that should exist for a service owner.
+	TeamTagPredicate     *Predicate   `graphql:"tagPredicate"`         // The condition that should be satisfied by the tag value.
 }
 
 func (client *Client) CreateCheckServiceOwnership(input CheckServiceOwnershipCreateInput) (*Check, error) {
diff --git a/check_has_recent_deploy.go b/check_has_recent_deploy.go
@@ -1,7 +1,7 @@
 package opslevel
 
 type HasRecentDeployCheckFragment struct {
-	Days int `graphql:"days"`
+	Days int `graphql:"days"` // The number of days to check since the last deploy.
 }
 
 func (client *Client) CreateCheckHasRecentDeploy(input CheckHasRecentDeployCreateInput) (*Check, error) {
diff --git a/check_manual.go b/check_manual.go
@@ -3,8 +3,8 @@ package opslevel
 import "github.com/relvacode/iso8601"
 
 type ManualCheckFragment struct {
-	UpdateFrequency       *ManualCheckFrequency `graphql:"updateFrequency"`
-	UpdateRequiresComment bool                  `graphql:"updateRequiresComment"`
+	UpdateFrequency       *ManualCheckFrequency `graphql:"updateFrequency"`       // The minimum frequency of the updates.
+	UpdateRequiresComment bool                  `graphql:"updateRequiresComment"` // Whether the check requires a comment or not.
 }
 
 type ManualCheckFrequency struct {
diff --git a/check_repo_file.go b/check_repo_file.go
@@ -1,10 +1,10 @@
 package opslevel
 
 type RepositoryFileCheckFragment struct {
-	DirectorySearch       bool       `graphql:"directorySearch"`
-	Filepaths             []string   `graphql:"filePaths"`
-	FileContentsPredicate *Predicate `graphql:"fileContentsPredicate"`
-	UseAbsoluteRoot       bool       `graphql:"useAbsoluteRoot"`
+	DirectorySearch       bool       `graphql:"directorySearch"`       // Whether the check looks for the existence of a directory instead of a file.
+	FileContentsPredicate *Predicate `graphql:"fileContentsPredicate"` // Condition to match the file content.
+	Filepaths             []string   `graphql:"filePaths"`             // Restrict the search to certain file paths.
+	UseAbsoluteRoot       bool       `graphql:"useAbsoluteRoot"`       // Whether the checks looks at the absolute root of a repo or the relative root (the directory specified when attached a repo to a service).
 }
 
 func (client *Client) CreateCheckRepositoryFile(input CheckRepositoryFileCreateInput) (*Check, error) {
diff --git a/check_repo_grep.go b/check_repo_grep.go
@@ -1,9 +1,9 @@
 package opslevel
 
 type RepositoryGrepCheckFragment struct {
-	DirectorySearch       bool      `graphql:"directorySearch"`
-	Filepaths             []string  `graphql:"filePaths"`
-	FileContentsPredicate Predicate `graphql:"fileContentsPredicate"`
+	DirectorySearch       bool      `graphql:"directorySearch"`       // Whether the check looks for the existence of a directory instead of a file.
+	FileContentsPredicate Predicate `graphql:"fileContentsPredicate"` // Condition to match the file content.
+	Filepaths             []string  `graphql:"filePaths"`             // Restrict the search to certain file paths.
 }
 
 func (client *Client) CreateCheckRepositoryGrep(input CheckRepositoryGrepCreateInput) (*Check, error) {
diff --git a/check_repo_search.go b/check_repo_search.go
@@ -1,8 +1,8 @@
 package opslevel
 
 type RepositorySearchCheckFragment struct {
-	FileExtensions        []string  `graphql:"fileExtensions"`
-	FileContentsPredicate Predicate `graphql:"fileContentsPredicate"`
+	FileContentsPredicate Predicate `graphql:"fileContentsPredicate"` // Condition to match the text content.
+	FileExtensions        []string  `graphql:"fileExtensions"`        // Restrict the search to files of given extensions.
 }
 
 func (client *Client) CreateCheckRepositorySearch(input CheckRepositorySearchCreateInput) (*Check, error) {
diff --git a/check_tag_defined.go b/check_tag_defined.go
@@ -1,8 +1,8 @@
 package opslevel
 
 type TagDefinedCheckFragment struct {
-	TagKey       string     `graphql:"tagKey"`
-	TagPredicate *Predicate `graphql:"tagPredicate"`
+	TagKey       string     `graphql:"tagKey"`       // The tag key where the tag predicate should be applied.
+	TagPredicate *Predicate `graphql:"tagPredicate"` // The condition that should be satisfied by the tag value.
 }
 
 func (client *Client) CreateCheckTagDefined(input CheckTagDefinedCreateInput) (*Check, error) {
diff --git a/check_test.go b/check_test.go
diff --git a/check_tool_usage.go b/check_tool_usage.go
diff --git a/enum.go b/enum.go
diff --git a/input.go b/input.go
diff --git a/interfaces.go b/interfaces.go
diff --git a/scalar.go b/scalar.go

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+kind: Feature`
	`2`	`+body: add CodeIssue check type`
	`3`	`+time: 2024-10-04T12:32:07.226978-05:00`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`	`package opslevel`
`2`	`2`
`3`	`3`	`type AlertSourceUsageCheckFragment struct {`
`4`		- AlertSourceNamePredicate *Predicate `graphql:"alertSourceNamePredicate"`
`5`		- AlertSourceType AlertSourceTypeEnum `graphql:"alertSourceType"`
	`4`	+ AlertSourceNamePredicate *Predicate `graphql:"alertSourceNamePredicate"` // The condition that the alert source name should satisfy to be evaluated.
	`5`	+ AlertSourceType AlertSourceTypeEnum `graphql:"alertSourceType"` // The type of the alert source.
`6`	`6`	`}`
`7`	`7`
`8`	`8`	`func (client Client) CreateCheckAlertSourceUsage(input CheckAlertSourceUsageCreateInput) (Check, error) {`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`	`package opslevel`
`2`	`2`
`3`	`3`	`type HasDocumentationCheckFragment struct {`
`4`		- DocumentType HasDocumentationTypeEnum `graphql:"documentType"`
`5`		- DocumentSubtype HasDocumentationSubtypeEnum `graphql:"documentSubtype"`
	`4`	+ DocumentSubtype HasDocumentationSubtypeEnum `graphql:"documentSubtype"` // The subtype of the document.
	`5`	+ DocumentType HasDocumentationTypeEnum `graphql:"documentType"` // The type of the document.
`6`	`6`	`}`
`7`	`7`
`8`	`8`	`func (client Client) CreateCheckHasDocumentation(input CheckHasDocumentationCreateInput) (Check, error) {`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`package opslevel`
`2`	`2`
`3`	`3`	`type HasRecentDeployCheckFragment struct {`
`4`		- Days int `graphql:"days"`
	`4`	+ Days int `graphql:"days"` // The number of days to check since the last deploy.
`5`	`5`	`}`
`6`	`6`
`7`	`7`	`func (client Client) CreateCheckHasRecentDeploy(input CheckHasRecentDeployCreateInput) (Check, error) {`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,8 @@ package opslevel`
`3`	`3`	`import "github.com/relvacode/iso8601"`
`4`	`4`
`5`	`5`	`type ManualCheckFragment struct {`
`6`		- UpdateFrequency *ManualCheckFrequency `graphql:"updateFrequency"`
`7`		- UpdateRequiresComment bool `graphql:"updateRequiresComment"`
	`6`	+ UpdateFrequency *ManualCheckFrequency `graphql:"updateFrequency"` // The minimum frequency of the updates.
	`7`	+ UpdateRequiresComment bool `graphql:"updateRequiresComment"` // Whether the check requires a comment or not.
`8`	`8`	`}`
`9`	`9`
`10`	`10`	`type ManualCheckFrequency struct {`