feat: Add JSON marshal tests for dependabot alerts (#3480)

Author: raisa2010

github/dependabot_alerts_test.go

@@ -10,6 +10,7 @@ import (
 	"fmt"
 	"net/http"
 	"testing"
+	"time"
 
 	"github.com/google/go-cmp/cmp"
 )
@@ -177,3 +178,212 @@ func TestDependabotService_UpdateAlert(t *testing.T) {
 		return resp, err
 	})
 }
+
+func TestDependency_Marshal(t *testing.T) {
+	t.Parallel()
+	testJSONMarshal(t, &Dependency{}, "{}")
+
+	h := &Dependency{
+		Package: &VulnerabilityPackage{
+			Ecosystem: Ptr("pip"),
+			Name:      Ptr("django"),
+		},
+		ManifestPath: Ptr("path/to/requirements.txt"),
+		Scope:        Ptr("runtime"),
+	}
+
+	want := `{
+		"package": {
+        "ecosystem": "pip",
+        "name": "django"
+      },
+      "manifest_path": "path/to/requirements.txt",
+      "scope": "runtime"
+	}`
+
+	testJSONMarshal(t, h, want)
+}
+
+func TestAdvisoryCVSS_Marshal(t *testing.T) {
+	t.Parallel()
+	testJSONMarshal(t, &AdvisoryCVSS{}, "{}")
+
+	h := &AdvisoryCVSS{
+		Score:        Ptr(7.5),
+		VectorString: Ptr("CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N"),
+	}
+
+	want := `{
+		"vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N",
+        "score": 7.5
+	}`
+
+	testJSONMarshal(t, h, want)
+}
+
+func TestAdvisoryCWEs_Marshal(t *testing.T) {
+	t.Parallel()
+	testJSONMarshal(t, &AdvisoryCWEs{}, "{}")
+
+	h := &AdvisoryCWEs{
+		CWEID: Ptr("CWE-200"),
+		Name:  Ptr("Exposure of Sensitive Information to an Unauthorized Actor"),
+	}
+
+	want := `{
+		"cwe_id": "CWE-200",
+		"name": "Exposure of Sensitive Information to an Unauthorized Actor"
+	}`
+
+	testJSONMarshal(t, h, want)
+}
+
+func TestDependabotSecurityAdvisory_Marshal(t *testing.T) {
+	t.Parallel()
+	testJSONMarshal(t, &DependabotSecurityAdvisory{}, "{}")
+
+	publishedAt, _ := time.Parse(time.RFC3339, "2018-10-03T21:13:54Z")
+	updatedAt, _ := time.Parse(time.RFC3339, "2022-04-26T18:35:37Z")
+
+	h := &DependabotSecurityAdvisory{
+		GHSAID:      Ptr("GHSA-rf4j-j272-fj86"),
+		CVEID:       Ptr("CVE-2018-6188"),
+		Summary:     Ptr("Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive"),
+		Description: Ptr("django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive."),
+		Vulnerabilities: []*AdvisoryVulnerability{
+			{
+				Package: &VulnerabilityPackage{
+					Ecosystem: Ptr("pip"),
+					Name:      Ptr("django"),
+				},
+				Severity:               Ptr("high"),
+				VulnerableVersionRange: Ptr(">= 2.0.0, < 2.0.2"),
+				FirstPatchedVersion:    &FirstPatchedVersion{Identifier: Ptr("2.0.2")},
+			},
+			{
+				Package: &VulnerabilityPackage{
+					Ecosystem: Ptr("pip"),
+					Name:      Ptr("django"),
+				},
+				Severity:               Ptr("high"),
+				VulnerableVersionRange: Ptr(">= 1.11.8, < 1.11.10"),
+				FirstPatchedVersion:    &FirstPatchedVersion{Identifier: Ptr("1.11.10")},
+			},
+		},
+		Severity: Ptr("high"),
+		CVSS: &AdvisoryCVSS{
+			Score:        Ptr(7.5),
+			VectorString: Ptr("CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N"),
+		},
+		CWEs: []*AdvisoryCWEs{
+			{
+				CWEID: Ptr("CWE-200"),
+				Name:  Ptr("Exposure of Sensitive Information to an Unauthorized Actor"),
+			},
+		},
+		Identifiers: []*AdvisoryIdentifier{
+			{
+				Type:  Ptr("GHSA"),
+				Value: Ptr("GHSA-rf4j-j272-fj86"),
+			},
+			{
+				Type:  Ptr("CVE"),
+				Value: Ptr("CVE-2018-6188"),
+			},
+		},
+		References: []*AdvisoryReference{
+			{
+				URL: Ptr("https://nvd.nist.gov/vuln/detail/CVE-2018-6188"),
+			},
+			{
+				URL: Ptr("https://github.com/advisories/GHSA-rf4j-j272-fj86"),
+			},
+			{
+				URL: Ptr("https://usn.ubuntu.com/3559-1/"),
+			},
+			{
+				URL: Ptr("https://www.djangoproject.com/weblog/2018/feb/01/security-releases/"),
+			},
+			{
+				URL: Ptr("http://www.securitytracker.com/id/1040422"),
+			},
+		},
+		PublishedAt: &Timestamp{publishedAt},
+		UpdatedAt:   &Timestamp{updatedAt},
+		WithdrawnAt: nil,
+	}
+
+	want := `{
+	  "ghsa_id": "GHSA-rf4j-j272-fj86",
+      "cve_id": "CVE-2018-6188",
+      "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive",
+      "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.",
+      "vulnerabilities": [
+        {
+          "package": {
+            "ecosystem": "pip",
+            "name": "django"
+          },
+          "severity": "high",
+          "vulnerable_version_range": ">= 2.0.0, < 2.0.2",
+          "first_patched_version": {
+            "identifier": "2.0.2"
+          }
+        },
+        {
+          "package": {
+            "ecosystem": "pip",
+            "name": "django"
+          },
+          "severity": "high",
+          "vulnerable_version_range": ">= 1.11.8, < 1.11.10",
+          "first_patched_version": {
+            "identifier": "1.11.10"
+          }
+        }
+      ],
+      "severity": "high",
+      "cvss": {
+        "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N",
+        "score": 7.5
+      },
+      "cwes": [
+        {
+          "cwe_id": "CWE-200",
+          "name": "Exposure of Sensitive Information to an Unauthorized Actor"
+        }
+      ],
+      "identifiers": [
+        {
+          "type": "GHSA",
+          "value": "GHSA-rf4j-j272-fj86"
+        },
+        {
+          "type": "CVE",
+          "value": "CVE-2018-6188"
+        }
+      ],
+      "references": [
+        {
+          "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188"
+        },
+        {
+          "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86"
+        },
+        {
+          "url": "https://usn.ubuntu.com/3559-1/"
+        },
+        {
+          "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/"
+        },
+        {
+          "url": "http://www.securitytracker.com/id/1040422"
+        }
+      ],
+      "published_at": "2018-10-03T21:13:54Z",
+      "updated_at": "2022-04-26T18:35:37Z",
+      "withdrawn_at": null
+	}`
+
+	testJSONMarshal(t, h, want)
+}