Add new unit tests for schemas pkg

Author: Tosta-Mista

pkg/schemas/environments_test.go

@@ -0,0 +1,152 @@
+package schemas
+
+import (
+	"hash/crc32"
+	"strconv"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestEnvironmentKey(t *testing.T) {
+	e := Environment{
+		ProjectName: "group/project",
+		Name:        "production",
+	}
+
+	expected := EnvironmentKey(strconv.Itoa(int(crc32.ChecksumIEEE([]byte("group/project" + "production")))))
+	assert.Equal(t, expected, e.Key())
+}
+
+func TestEnvironmentKey_SameInputSameKey(t *testing.T) {
+	e1 := Environment{
+		ProjectName: "group/project",
+		Name:        "staging",
+		ID:          1,
+	}
+	e2 := Environment{
+		ProjectName: "group/project",
+		Name:        "staging",
+		ID:          999,
+	}
+
+	assert.Equal(t, e1.Key(), e2.Key())
+}
+
+func TestEnvironmentKey_DifferentInputDifferentKey(t *testing.T) {
+	e1 := Environment{
+		ProjectName: "group/project",
+		Name:        "staging",
+	}
+	e2 := Environment{
+		ProjectName: "group/project",
+		Name:        "production",
+	}
+
+	assert.NotEqual(t, e1.Key(), e2.Key())
+}
+
+func TestEnvironmentsCount(t *testing.T) {
+	envs := Environments{
+		EnvironmentKey("1"): {ID: 1},
+		EnvironmentKey("2"): {ID: 2},
+		EnvironmentKey("3"): {ID: 3},
+	}
+
+	assert.Equal(t, 3, envs.Count())
+}
+
+func TestEnvironmentsCount_Empty(t *testing.T) {
+	envs := Environments{}
+	assert.Equal(t, 0, envs.Count())
+}
+
+func TestEnvironmentDefaultLabelsValues(t *testing.T) {
+	e := Environment{
+		ProjectName: "group/project",
+		Name:        "production",
+	}
+
+	got := e.DefaultLabelsValues()
+
+	expected := map[string]string{
+		"project":     "group/project",
+		"environment": "production",
+	}
+
+	assert.Equal(t, expected, got)
+}
+
+func TestEnvironmentInformationLabelsValues(t *testing.T) {
+	e := Environment{
+		ProjectName: "group/project",
+		ID:          42,
+		Name:        "production",
+		ExternalURL: "https://example.com",
+		Available:   true,
+		LatestDeployment: Deployment{
+			JobID:           1001,
+			RefKind:         RefKindBranch,
+			RefName:         "main",
+			Username:        "jdoe",
+			Timestamp:       1710000000,
+			DurationSeconds: 12.5,
+			CommitShortID:   "abc123",
+			Status:          "success",
+		},
+	}
+
+	got := e.InformationLabelsValues()
+
+	expected := map[string]string{
+		"project":                 "group/project",
+		"environment":             "production",
+		"environment_id":          "42",
+		"external_url":            "https://example.com",
+		"kind":                    "branch",
+		"ref":                     "main",
+		"current_commit_short_id": "abc123",
+		"latest_commit_short_id":  "",
+		"available":               "true",
+		"username":                "jdoe",
+	}
+
+	assert.Equal(t, expected, got)
+}
+
+func TestEnvironmentInformationLabelsValues_WithZeroValues(t *testing.T) {
+	e := Environment{
+		ProjectName: "group/project",
+		ID:          0,
+		Name:        "staging",
+		ExternalURL: "",
+		Available:   false,
+		LatestDeployment: Deployment{
+			JobID:           0,
+			RefKind:         "",
+			RefName:         "",
+			Username:        "",
+			Timestamp:       0,
+			DurationSeconds: 0,
+			CommitShortID:   "",
+			Status:          "",
+		},
+	}
+
+	got := e.InformationLabelsValues()
+
+	expected := map[string]string{
+		"project":                 "group/project",
+		"environment":             "staging",
+		"environment_id":          "0",
+		"external_url":            "",
+		"kind":                    "",
+		"ref":                     "",
+		"current_commit_short_id": "",
+		"latest_commit_short_id":  "",
+		"available":               "false",
+		"username":                "",
+	}
+
+	assert.Equal(t, expected, got)
+}

pkg/schemas/jobs_test.go

@@ -0,0 +1,156 @@
+package schemas
+
+import (
+	"encoding/json"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	goGitlab "gitlab.com/gitlab-org/api/client-go"
+)
+
+func mustJobFromJSON(t *testing.T, raw string) goGitlab.Job {
+	t.Helper()
+
+	var job goGitlab.Job
+	err := json.Unmarshal([]byte(raw), &job)
+	require.NoError(t, err)
+
+	return job
+}
+
+func mustParseTime(t *testing.T, raw string) time.Time {
+	t.Helper()
+
+	ts, err := time.Parse(time.RFC3339, raw)
+	require.NoError(t, err)
+
+	return ts
+}
+
+func TestNewJob(t *testing.T) {
+	gj := mustJobFromJSON(t, `{
+		"id": 101,
+		"name": "unit-tests",
+		"stage": "test",
+		"created_at": "2024-03-09T16:00:00Z",
+		"duration": 42.5,
+		"queued_duration": 3.2,
+		"status": "success",
+		"tag_list": ["docker", "linux"],
+		"failure_reason": "",
+		"pipeline": {
+			"id": 999
+		},
+		"artifacts": [
+			{"size": 100},
+			{"size": 250},
+			{"size": 50}
+		],
+		"runner": {
+			"description": "shared-runner-1"
+		}
+	}`)
+
+	expectedCreatedAt := mustParseTime(t, "2024-03-09T16:00:00Z")
+
+	got := NewJob(gj)
+
+	assert.Equal(t, 101, got.ID)
+	assert.Equal(t, "unit-tests", got.Name)
+	assert.Equal(t, "test", got.Stage)
+	assert.Equal(t, float64(expectedCreatedAt.Unix()), got.Timestamp)
+	assert.Equal(t, 42.5, got.DurationSeconds)
+	assert.Equal(t, 3.2, got.QueuedDurationSeconds)
+	assert.Equal(t, "success", got.Status)
+	assert.Equal(t, 999, got.PipelineID)
+	assert.Equal(t, "docker,linux", got.TagList)
+	assert.Equal(t, 400.0, got.ArtifactSize)
+	assert.Equal(t, "", got.FailureReason)
+	assert.Equal(t, "shared-runner-1", got.Runner.Description)
+}
+
+func TestNewJob_NoCreatedAt(t *testing.T) {
+	gj := mustJobFromJSON(t, `{
+		"id": 102,
+		"name": "build",
+		"stage": "build",
+		"duration": 10,
+		"queued_duration": 1,
+		"status": "running",
+		"tag_list": ["kubernetes"],
+		"pipeline": {
+			"id": 1000
+		},
+		"artifacts": [
+			{"size": 500}
+		],
+		"runner": {
+			"description": "runner-k8s"
+		}
+	}`)
+
+	got := NewJob(gj)
+
+	assert.Equal(t, 0.0, got.Timestamp)
+	assert.Equal(t, 500.0, got.ArtifactSize)
+	assert.Equal(t, "kubernetes", got.TagList)
+	assert.Equal(t, "runner-k8s", got.Runner.Description)
+}
+
+func TestNewJob_EmptyArtifactsAndTags(t *testing.T) {
+	gj := mustJobFromJSON(t, `{
+		"id": 103,
+		"name": "deploy",
+		"stage": "deploy",
+		"created_at": "2024-03-09T16:01:40Z",
+		"duration": 5,
+		"queued_duration": 0.5,
+		"status": "failed",
+		"tag_list": [],
+		"failure_reason": "script_failure",
+		"pipeline": {
+			"id": 1001
+		},
+		"artifacts": [],
+		"runner": {
+			"description": ""
+		}
+	}`)
+
+	expectedCreatedAt := mustParseTime(t, "2024-03-09T16:01:40Z")
+
+	got := NewJob(gj)
+
+	assert.Equal(t, 103, got.ID)
+	assert.Equal(t, "deploy", got.Name)
+	assert.Equal(t, "deploy", got.Stage)
+	assert.Equal(t, float64(expectedCreatedAt.Unix()), got.Timestamp)
+	assert.Equal(t, 5.0, got.DurationSeconds)
+	assert.Equal(t, 0.5, got.QueuedDurationSeconds)
+	assert.Equal(t, "failed", got.Status)
+	assert.Equal(t, 1001, got.PipelineID)
+	assert.Equal(t, "", got.TagList)
+	assert.Equal(t, 0.0, got.ArtifactSize)
+	assert.Equal(t, "script_failure", got.FailureReason)
+	assert.Equal(t, "", got.Runner.Description)
+}
+
+func TestNewJob_ArtifactSizeSum(t *testing.T) {
+	gj := mustJobFromJSON(t, `{
+		"pipeline": {
+			"id": 1
+		},
+		"artifacts": [
+			{"size": 1},
+			{"size": 2},
+			{"size": 3},
+			{"size": 4}
+		]
+	}`)
+
+	got := NewJob(gj)
+
+	assert.Equal(t, 10.0, got.ArtifactSize)
+}