Skip to content

Commit

Permalink
internal/osv: add review status
Browse files Browse the repository at this point in the history
Ecosystem metrics cannot pick up REVIEWED vs UNREVIWED unless
govulncheck produces it.

Change-Id: Ia6ea1ef7cf681ac51e18dd32748dc658a72ebad9
Reviewed-on: https://go-review.googlesource.com/c/vuln/+/591055
Reviewed-by: Tatiana Bradley <tatianabradley@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Run-TryBot: Zvonimir Pavlinovic <zpavlinovic@google.com>
  • Loading branch information
zpavlinovic committed Jun 6, 2024
1 parent 29462d7 commit 3740f5c
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 0 deletions.
2 changes: 2 additions & 0 deletions internal/osv/osv.go
Original file line number Diff line number Diff line change
Expand Up @@ -235,4 +235,6 @@ type DatabaseSpecific struct {
// The URL of the Go advisory for this vulnerability, of the form
// "https://pkg.go.dev/GO-YYYY-XXXX".
URL string `json:"url,omitempty"`
// The review status of this report (UNREVIEWED or REVIEWED).
ReviewStatus ReviewStatus `json:"review_status,omitempty"`
}
67 changes: 67 additions & 0 deletions internal/osv/review_status.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
// Copyright 2024 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package osv

import (
"encoding/json"
"fmt"
)

type ReviewStatus int

const (
ReviewStatusUnknown ReviewStatus = iota
ReviewStatusUnreviewed
ReviewStatusReviewed
)

var statusStrs = []string{
ReviewStatusUnknown: "",
ReviewStatusUnreviewed: "UNREVIEWED",
ReviewStatusReviewed: "REVIEWED",
}

func (r ReviewStatus) String() string {
if !r.IsValid() {
return fmt.Sprintf("INVALID(%d)", r)
}
return statusStrs[r]
}

func ReviewStatusValues() []string {
return statusStrs[1:]
}

func (r ReviewStatus) IsValid() bool {
return int(r) >= 0 && int(r) < len(statusStrs)
}

func ToReviewStatus(s string) (ReviewStatus, bool) {
for stat, str := range statusStrs {
if s == str {
return ReviewStatus(stat), true
}
}
return 0, false
}

func (r ReviewStatus) MarshalJSON() ([]byte, error) {
if !r.IsValid() {
return nil, fmt.Errorf("MarshalJSON: unrecognized review status: %d", r)
}
return json.Marshal(r.String())
}

func (r *ReviewStatus) UnmarshalJSON(b []byte) error {
var s string
if err := json.Unmarshal(b, &s); err != nil {
return err
}
if rs, ok := ToReviewStatus(s); ok {
*r = rs
return nil
}
return fmt.Errorf("UnmarshalJSON: unrecognized review status: %s", s)
}

0 comments on commit 3740f5c

Please sign in to comment.