Merge pull request #10 from wneessen/omitted

Add omitted functionallity

.github/workflows/dependency-review.yml

@@ -0,0 +1,31 @@
+# SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
+#
+# SPDX-License-Identifier: CC0-1.0
+
+# Dependency Review Action
+#
+# This Action will scan dependency manifest files that change as part of a Pull Request,
+# surfacing known-vulnerable versions of the packages declared or updated in the PR.
+# Once installed, if the workflow run is marked as required,
+# PRs introducing known-vulnerable packages will be blocked from merging.
+#
+# Source repository: https://github.com/actions/dependency-review-action
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
+        with:
+          egress-policy: audit
+
+      - name: 'Checkout Repository'
+        uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@5a2ce3f5b92ee19cbb1541a4984c76d921601d7c # v4.3.4

.github/workflows/govulncheck.yml

@@ -0,0 +1,21 @@
+# SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+#
+# SPDX-License-Identifier: CC0-1.0
+
+name: Govulncheck Security Scan
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps: 
+    - name: Harden Runner
+      uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
+      with:
+        egress-policy: audit
+    - name: Run govulncheck
+      uses: golang/govulncheck-action@dd0578b371c987f96d1185abb54344b44352bd58 # v1.0.3

.github/workflows/scorecards.yml

@@ -0,0 +1,80 @@
+# SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
+#
+# SPDX-License-Identifier: CC0-1.0
+
+# This workflow uses actions that are not certified by GitHub. They are provided
+# by a third-party and are governed by separate terms of service, privacy
+# policy, and support documentation.
+
+name: Scorecard supply-chain security
+on:
+  # For Branch-Protection check. Only the default branch is supported. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
+  branch_protection_rule:
+  # To guarantee Maintained check is occasionally updated. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
+  schedule:
+    - cron: '20 7 * * 2'
+  push:
+    branches: ["main"]
+
+# Declare default permissions as read only.
+permissions: read-all
+
+jobs:
+  analysis:
+    name: Scorecard analysis
+    runs-on: ubuntu-latest
+    permissions:
+      # Needed to upload the results to code-scanning dashboard.
+      security-events: write
+      # Needed to publish results and get a badge (see publish_results below).
+      id-token: write
+      contents: read
+      actions: read
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
+        with:
+          egress-policy: audit
+
+      - name: "Checkout code"
+        uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+        with:
+          persist-credentials: false
+
+      - name: "Run analysis"
+        uses: ossf/scorecard-action@62b2cac7ed8198b15735ed49ab1e5cf35480ba46 # v2.4.0
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          # (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
+          # - you want to enable the Branch-Protection check on a *public* repository, or
+          # - you are installing Scorecards on a *private* repository
+          # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
+          # repo_token: ${{ secrets.SCORECARD_TOKEN }}
+
+          # Public repositories:
+          #   - Publish results to OpenSSF REST API for easy access by consumers
+          #   - Allows the repository to include the Scorecard badge.
+          #   - See https://github.com/ossf/scorecard-action#publishing-results.
+          # For private repositories:
+          #   - `publish_results` will always be set to `false`, regardless
+          #     of the value entered here.
+          publish_results: true
+
+      # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
+      # format to the repository Actions tab.
+      - name: "Upload artifact"
+        uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+
+      # Upload the results to GitHub's code scanning dashboard.
+      - name: "Upload to code-scanning"
+        uses: github/codeql-action/upload-sarif@4dd16135b69a43b6c8efb853346f8437d92d3c93 # v3.26.6
+        with:
+          sarif_file: results.sarif

.github/workflows/sonarqube.yml

@@ -0,0 +1,47 @@
+# SPDX-FileCopyrightText: 2024 Winni Neessen <winni@neessen.dev>
+#
+# SPDX-License-Identifier: CC0-1.0
+
+name: SonarQube
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Build and analyze
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Go
+        uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5.0.2
+        with:
+          go-version: '1.23'
+
+      - name: Run unit Tests
+        run: |
+          go test -v -race --coverprofile=./cov.out ./...
+
+      - uses: sonarsource/sonarqube-scan-action@master
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
+
+      - uses: sonarsource/sonarqube-quality-gate-action@master
+        timeout-minutes: 5
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

README.md

@@ -14,10 +14,11 @@ SPDX-License-Identifier: CC0-1.0
 
 niljson provides a simple and efficient way to handle nullable JSON fields during the (un-)marshalling process. 
 In JSON, it's common to encounter fields that can be `null`, but handling these fields in Go can be cumbersome, 
-especially when dealing with primitive types like `int`, `float64`, `bool`. These types can all be either `0` (as value)
+especially when dealing with primitive types like `int`, `float64`, and `bool`. These types can all be either `0` 
-or `null`. In Go you can always work with pointers but these, of course, can lead to unhandled nil pointer dereferences.
+(as a value) or `null`. In Go you can always work with pointers, but these can lead to unhandled nil 
+pointer dereferences.
 
-**niljaon** addresses this challenge by offering a set of types that can seamlessly handle `null` values during 
+**niljson** addresses this challenge by offering a set of types that can seamlessly handle `null` values during 
 unmarshalling, allowing your Go applications to work with JSON data more naturally and with fewer boilerplate 
 checks for `nil` values.
 

niljson.go

@@ -8,42 +8,6 @@ import (
 	"encoding/json"
 )
 
-// Variable is a generic variable type that can be null.
-type Variable[T any] struct {
-	value  T
-	notNil bool
-}
-
-// Value returns the value of the Variable
-func (v *Variable[T]) Value() T {
-	return v.value
-}
-
-// NotNil returns true when a Variable is not nil
-func (v *Variable[T]) NotNil() bool {
-	return v.notNil
-}
-
-// IsNil returns true when a Variable is nil
-func (v *Variable[T]) IsNil() bool {
-	return !v.notNil
-}
-
-// Reset resets the value to the Variable to a zero value and sets it to be nil
-func (v *Variable[T]) Reset() {
-	var newVal T
-	v.value = newVal
-	v.notNil = false
-}
-
-// NewVariable returns a new Variable of generic type
-func NewVariable[T any](value T) Variable[T] {
-	return Variable[T]{
-		notNil: true,
-		value:  value,
-	}
-}
-
 // NilBoolean is an boolean type that can be nil
 type NilBoolean = Variable[bool]
 
@@ -80,14 +44,46 @@ type NilFloat64 = Variable[float64]
 // NilString is a string type that can be nil
 type NilString = Variable[string]
 
-// UnmarshalJSON satisfies the json.Unmarshaler interface for generic Variable types
+// Variable is a generic variable type that can be null.
-func (v *Variable[T]) UnmarshalJSON(data []byte) error {
+type Variable[T any] struct {
-	if string(data) != "null" {
+	value   T
-		v.value = *new(T)
+	notNil  bool
-		v.notNil = true
+	present bool
-		return json.Unmarshal(data, &v.value)
 }
-	return nil
+
+// NewVariable returns a new Variable of generic type
+func NewVariable[T any](value T) Variable[T] {
+	return Variable[T]{
+		notNil: true,
+		value:  value,
+	}
+}
+
+// IsNil returns true when a Variable is nil
+func (v *Variable[T]) IsNil() bool {
+	return !v.notNil
+}
+
+// NotNil returns true when a Variable is not nil
+func (v *Variable[T]) NotNil() bool {
+	return v.notNil
+}
+
+// Omitted returns true if a value was omitted in the JSON
+func (v *Variable[T]) Omitted() bool {
+	return !v.present
+}
+
+// Reset resets the value to the Variable to a zero value and sets it to be nil
+func (v *Variable[T]) Reset() {
+	var newVal T
+	v.value = newVal
+	v.notNil = false
+}
+
+// Value returns the value of the Variable
+func (v *Variable[T]) Value() T {
+	return v.value
 }
 
 // MarshalJSON satisfies the json.Marshaler interface for generic Variable types
@@ -97,3 +93,14 @@ func (v *Variable[T]) MarshalJSON() ([]byte, error) {
 	}
 	return json.Marshal(v.value)
 }
+
+// UnmarshalJSON satisfies the json.Unmarshaler interface for generic Variable types
+func (v *Variable[T]) UnmarshalJSON(data []byte) error {
+	v.present = true
+	if string(data) != "null" {
+		v.value = *new(T)
+		v.notNil = true
+		return json.Unmarshal(data, &v.value)
+	}
+	return nil
+}

niljson_test.go

@@ -12,6 +12,17 @@ import (
 	"testing"
 )
 
+// List of common errors
+const (
+	ErrUnmarshalFailed    = "failed to unmarshal json with nil types: %s"
+	ErrMarshalFailed      = "failed to marshal json with nil types: %s"
+	ErrExpectedJSONString = "expected json to be %q, got %q"
+	ErrExpectedJSONInt    = "expected json to be %d, got %d"
+	ErrExpectedValue      = "expected value, but got nil"
+	ErrExpectedNil        = "expected nil, but got value"
+	ErrExpectedNilReset   = "expected value to be nil after reset"
+)
+
 var jsonBytes = []byte(
 	`{
 		"bool": true,
@@ -37,14 +48,14 @@ func TestVariable_UnmarshalJSON_Boolean(t *testing.T) {
 
 	var jt JSONType
 	if err := json.Unmarshal(jsonBytes, &jt); err != nil {
-		t.Errorf("failed to unmarshal json with nil types: %s", err)
+		t.Errorf(ErrUnmarshalFailed, err)
 	}
 
 	if jt.Value.IsNil() {
-		t.Errorf("expected value, but got nil")
+		t.Error(ErrExpectedValue)
 	}
 	if jt.NilValue.NotNil() {
-		t.Errorf("expected nil, but got value")
+		t.Error(ErrExpectedNil)
 	}
 	if !jt.Value.Value() {
 		t.Errorf("expected value to be true, got %t", jt.Value.Value())
@@ -52,7 +63,7 @@ func TestVariable_UnmarshalJSON_Boolean(t *testing.T) {
 
 	jt.Value.Reset()
 	if jt.Value.NotNil() {
-		t.Errorf("expected value to be nil after reset")
+		t.Error(ErrExpectedNilReset)
 	}
 }
 
@@ -68,10 +79,10 @@ func TestVariable_MarshalJSON_Boolean(t *testing.T) {
 	}
 	data, err := json.Marshal(&jt)
 	if err != nil {
-		t.Errorf("failed to marshal json with nil types: %s", err)
+		t.Errorf(ErrMarshalFailed, err)
 	}
 	if !bytes.Equal(data, []byte(expected)) {
-		t.Errorf("expected json to be %q, got %q", expected, string(data))
+		t.Errorf(ErrExpectedJSONString, expected, string(data))
 	}
 }
 
@@ -83,14 +94,14 @@ func TestVariable_UnmarshalJSON_ByteSlice(t *testing.T) {
 
 	var jt JSONType
 	if err := json.Unmarshal(jsonBytes, &jt); err != nil {
-		t.Errorf("failed to unmarshal json with nil types: %s", err)
+		t.Errorf(ErrUnmarshalFailed, err)
 	}
 
 	if jt.Value.IsNil() {
-		t.Errorf("expected value, but got nil")
+		t.Error(ErrExpectedValue)
 	}
 	if jt.NilValue.NotNil() {
-		t.Errorf("expected nil, but got value")
+		t.Error(ErrExpectedNil)
 	}
 	if !bytes.Equal(jt.Value.Value(), []byte("bytes")) {
 		t.Errorf("expected value to be %q, got %q", "bytes", jt.Value.Value())
@@ -98,7 +109,7 @@ func TestVariable_UnmarshalJSON_ByteSlice(t *testing.T) {
 
 	jt.Value.Reset()
 	if jt.Value.NotNil() {
-		t.Errorf("expected value to be nil after reset")
+		t.Error(ErrExpectedNilReset)
 	}
 }
 
@@ -114,10 +125,10 @@ func TestVariable_MarshalJSON_ByteSlice(t *testing.T) {
 	}
 	data, err := json.Marshal(&jt)
 	if err != nil {
-		t.Errorf("failed to marshal json with nil types: %s", err)
+		t.Errorf(ErrMarshalFailed, err)
 	}
 	if !bytes.Equal(data, []byte(expected)) {
-		t.Errorf("expected json to be %q, got %q", expected, string(data))
+		t.Errorf(ErrExpectedJSONString, expected, string(data))
 	}
 }
 
@@ -130,14 +141,14 @@ func TestVariable_UnmarshalJSON_Float32(t *testing.T) {
 
 	var jt JSONType
 	if err := json.Unmarshal(jsonBytes, &jt); err != nil {
-		t.Errorf("failed to unmarshal json with nil types: %s", err)
+		t.Errorf(ErrUnmarshalFailed, err)
 	}
 
 	if jt.Value.IsNil() {
-		t.Errorf("expected value, but got nil")
+		t.Error(ErrExpectedValue)
 	}
 	if jt.NilValue.NotNil() {
-		t.Errorf("expected nil, but got value")
+		t.Error(ErrExpectedNil)
 	}
 	if jt.Value.Value() != expected {
 		t.Errorf("expected value to be %f, got %f", expected, jt.Value.Value())
@@ -145,7 +156,7 @@ func TestVariable_UnmarshalJSON_Float32(t *testing.T) {
 
 	jt.Value.Reset()
 	if jt.Value.NotNil() {
-		t.Errorf("expected value to be nil after reset")
+		t.Error(ErrExpectedNilReset)
 	}
 }
 
@@ -161,10 +172,10 @@ func TestVariable_MarshalJSON_Float32(t *testing.T) {
 	}
 	data, err := json.Marshal(&jt)
 	if err != nil {
-		t.Errorf("failed to marshal json with nil types: %s", err)
+		t.Errorf(ErrMarshalFailed, err)
 	}
 	if !bytes.Equal(data, []byte(expected)) {
-		t.Errorf("expected json to be %q, got %q", expected, string(data))
+		t.Errorf(ErrExpectedJSONString, expected, string(data))
 	}
 }
 
@@ -177,14 +188,14 @@ func TestVariable_UnmarshalJSON_Float64(t *testing.T) {
 
 	var jt JSONType
 	if err := json.Unmarshal(jsonBytes, &jt); err != nil {
-		t.Errorf("failed to unmarshal json with nil types: %s", err)
+		t.Errorf(ErrUnmarshalFailed, err)
 	}
 
 	if jt.Value.IsNil() {
-		t.Errorf("expected value, but got nil")
+		t.Error(ErrExpectedValue)
 	}
 	if jt.NilValue.NotNil() {
-		t.Errorf("expected nil, but got value")
+		t.Error(ErrExpectedNil)
 	}
 	if jt.Value.Value() != expected {
 		t.Errorf("expected value to be %f, got %f", expected, jt.Value.Value())
@@ -192,7 +203,7 @@ func TestVariable_UnmarshalJSON_Float64(t *testing.T) {
 
 	jt.Value.Reset()
 	if jt.Value.NotNil() {
-		t.Errorf("expected value to be nil after reset")
+		t.Error(ErrExpectedNilReset)
 	}
 }
 
@@ -208,10 +219,10 @@ func TestVariable_MarshalJSON_Float64(t *testing.T) {
 	}
 	data, err := json.Marshal(&jt)
 	if err != nil {
-		t.Errorf("failed to marshal json with nil types: %s", err)
+		t.Errorf(ErrMarshalFailed, err)
 	}
 	if !bytes.Equal(data, []byte(expected)) {
-		t.Errorf("expected json to be %q, got %q", expected, string(data))
+		t.Errorf(ErrExpectedJSONString, expected, string(data))
 	}
 }
 
@@ -224,22 +235,22 @@ func TestVariable_UnmarshalJSON_Int(t *testing.T) {
 
 	var jt JSONType
 	if err := json.Unmarshal(jsonBytes, &jt); err != nil {
-		t.Errorf("failed to unmarshal json with nil types: %s", err)
+		t.Errorf(ErrUnmarshalFailed, err)
 	}
 
 	if jt.Value.IsNil() {
-		t.Errorf("expected value, but got nil")
+		t.Error(ErrExpectedValue)
 	}
 	if jt.NilValue.NotNil() {
-		t.Errorf("expected nil, but got value")
+		t.Error(ErrExpectedNil)
 	}
 	if jt.Value.Value() != expected {
-		t.Errorf("expected value to be %d, got %d", expected, jt.Value.Value())
+		t.Errorf(ErrExpectedJSONInt, expected, jt.Value.Value())
 	}
 
 	jt.Value.Reset()
 	if jt.Value.NotNil() {
-		t.Errorf("expected value to be nil after reset")
+		t.Error(ErrExpectedNilReset)
 	}
 }
 
@@ -255,10 +266,10 @@ func TestVariable_MarshalJSON_Int(t *testing.T) {
 	}
 	data, err := json.Marshal(&jt)
 	if err != nil {
-		t.Errorf("failed to marshal json with nil types: %s", err)
+		t.Errorf(ErrMarshalFailed, err)
 	}
 	if !bytes.Equal(data, []byte(expected)) {
-		t.Errorf("expected json to be %q, got %q", expected, string(data))
+		t.Errorf(ErrExpectedJSONString, expected, string(data))
 	}
 }
 
@@ -271,22 +282,22 @@ func TestVariable_UnmarshalJSON_Int64(t *testing.T) {
 
 	var jt JSONType
 	if err := json.Unmarshal(jsonBytes, &jt); err != nil {
-		t.Errorf("failed to unmarshal json with nil types: %s", err)
+		t.Errorf(ErrUnmarshalFailed, err)
 	}
 
 	if jt.Value.IsNil() {
-		t.Errorf("expected value, but got nil")
+		t.Error(ErrExpectedValue)
 	}
 	if jt.NilValue.NotNil() {
-		t.Errorf("expected nil, but got value")
+		t.Error(ErrExpectedNil)
 	}
 	if jt.Value.Value() != expected {
-		t.Errorf("expected value to be %d, got %d", expected, jt.Value.Value())
+		t.Errorf(ErrExpectedJSONInt, expected, jt.Value.Value())
 	}
 
 	jt.Value.Reset()
 	if jt.Value.NotNil() {
-		t.Errorf("expected value to be nil after reset")
+		t.Error(ErrExpectedNilReset)
 	}
 }
 
@@ -302,10 +313,10 @@ func TestVariable_MarshalJSON_Int64(t *testing.T) {
 	}
 	data, err := json.Marshal(&jt)
 	if err != nil {
-		t.Errorf("failed to marshal json with nil types: %s", err)
+		t.Errorf(ErrMarshalFailed, err)
 	}
 	if !bytes.Equal(data, []byte(expected)) {
-		t.Errorf("expected json to be %q, got %q", expected, string(data))
+		t.Errorf(ErrExpectedJSONString, expected, string(data))
 	}
 }
 
@@ -318,14 +329,14 @@ func TestVariable_UnmarshalJSON_String(t *testing.T) {
 
 	var jt JSONType
 	if err := json.Unmarshal(jsonBytes, &jt); err != nil {
-		t.Errorf("failed to unmarshal json with nil types: %s", err)
+		t.Errorf(ErrUnmarshalFailed, err)
 	}
 
 	if jt.Value.IsNil() {
-		t.Errorf("expected value, but got nil")
+		t.Error(ErrExpectedValue)
 	}
 	if jt.NilValue.NotNil() {
-		t.Errorf("expected nil, but got value")
+		t.Error(ErrExpectedNil)
 	}
 	if jt.Value.Value() != expected {
 		t.Errorf("expected value to be %s, got %s", expected, jt.Value.Value())
@@ -333,7 +344,7 @@ func TestVariable_UnmarshalJSON_String(t *testing.T) {
 
 	jt.Value.Reset()
 	if jt.Value.NotNil() {
-		t.Errorf("expected value to be nil after reset")
+		t.Error(ErrExpectedNilReset)
 	}
 }
 
@@ -349,10 +360,10 @@ func TestVariable_MarshalJSON_String(t *testing.T) {
 	}
 	data, err := json.Marshal(&jt)
 	if err != nil {
-		t.Errorf("failed to marshal json with nil types: %s", err)
+		t.Errorf(ErrMarshalFailed, err)
 	}
 	if !bytes.Equal(data, []byte(expected)) {
-		t.Errorf("expected json to be %q, got %q", expected, string(data))
+		t.Errorf(ErrExpectedJSONString, expected, string(data))
 	}
 }
 
@@ -365,22 +376,22 @@ func TestVariable_UnmarshalJSON_UInt(t *testing.T) {
 
 	var jt JSONType
 	if err := json.Unmarshal(jsonBytes, &jt); err != nil {
-		t.Errorf("failed to unmarshal json with nil types: %s", err)
+		t.Errorf(ErrUnmarshalFailed, err)
 	}
 
 	if jt.Value.IsNil() {
-		t.Errorf("expected value, but got nil")
+		t.Error(ErrExpectedValue)
 	}
 	if jt.NilValue.NotNil() {
-		t.Errorf("expected nil, but got value")
+		t.Error(ErrExpectedNil)
 	}
 	if jt.Value.Value() != expected {
-		t.Errorf("expected value to be %d, got %d", expected, jt.Value.Value())
+		t.Errorf(ErrExpectedJSONInt, expected, jt.Value.Value())
 	}
 
 	jt.Value.Reset()
 	if jt.Value.NotNil() {
-		t.Errorf("expected value to be nil after reset")
+		t.Error(ErrExpectedNilReset)
 	}
 }
 
@@ -396,10 +407,10 @@ func TestVariable_MarshalJSON_UInt(t *testing.T) {
 	}
 	data, err := json.Marshal(&jt)
 	if err != nil {
-		t.Errorf("failed to marshal json with nil types: %s", err)
+		t.Errorf(ErrMarshalFailed, err)
 	}
 	if !bytes.Equal(data, []byte(expected)) {
-		t.Errorf("expected json to be %q, got %q", expected, string(data))
+		t.Errorf(ErrExpectedJSONString, expected, string(data))
 	}
 }
 
@@ -412,22 +423,22 @@ func TestVariable_UnmarshalJSON_UInt8(t *testing.T) {
 
 	var jt JSONType
 	if err := json.Unmarshal(jsonBytes, &jt); err != nil {
-		t.Errorf("failed to unmarshal json with nil types: %s", err)
+		t.Errorf(ErrUnmarshalFailed, err)
 	}
 
 	if jt.Value.IsNil() {
-		t.Errorf("expected value, but got nil")
+		t.Error(ErrExpectedValue)
 	}
 	if jt.NilValue.NotNil() {
-		t.Errorf("expected nil, but got value")
+		t.Error(ErrExpectedNil)
 	}
 	if jt.Value.Value() != expected {
-		t.Errorf("expected value to be %d, got %d", expected, jt.Value.Value())
+		t.Errorf(ErrExpectedJSONInt, expected, jt.Value.Value())
 	}
 
 	jt.Value.Reset()
 	if jt.Value.NotNil() {
-		t.Errorf("expected value to be nil after reset")
+		t.Error(ErrExpectedNilReset)
 	}
 }
 
@@ -443,10 +454,10 @@ func TestVariable_MarshalJSON_UInt8(t *testing.T) {
 	}
 	data, err := json.Marshal(&jt)
 	if err != nil {
-		t.Errorf("failed to marshal json with nil types: %s", err)
+		t.Errorf(ErrMarshalFailed, err)
 	}
 	if !bytes.Equal(data, []byte(expected)) {
-		t.Errorf("expected json to be %q, got %q", expected, string(data))
+		t.Errorf(ErrExpectedJSONString, expected, string(data))
 	}
 }
 
@@ -459,22 +470,22 @@ func TestVariable_UnmarshalJSON_UInt16(t *testing.T) {
 
 	var jt JSONType
 	if err := json.Unmarshal(jsonBytes, &jt); err != nil {
-		t.Errorf("failed to unmarshal json with nil types: %s", err)
+		t.Errorf(ErrUnmarshalFailed, err)
 	}
 
 	if jt.Value.IsNil() {
-		t.Errorf("expected value, but got nil")
+		t.Error(ErrExpectedValue)
 	}
 	if jt.NilValue.NotNil() {
-		t.Errorf("expected nil, but got value")
+		t.Error(ErrExpectedNil)
 	}
 	if jt.Value.Value() != expected {
-		t.Errorf("expected value to be %d, got %d", expected, jt.Value.Value())
+		t.Errorf(ErrExpectedJSONInt, expected, jt.Value.Value())
 	}
 
 	jt.Value.Reset()
 	if jt.Value.NotNil() {
-		t.Errorf("expected value to be nil after reset")
+		t.Error(ErrExpectedNilReset)
 	}
 }
 
@@ -490,10 +501,10 @@ func TestVariable_MarshalJSON_UInt16(t *testing.T) {
 	}
 	data, err := json.Marshal(&jt)
 	if err != nil {
-		t.Errorf("failed to marshal json with nil types: %s", err)
+		t.Errorf(ErrMarshalFailed, err)
 	}
 	if !bytes.Equal(data, []byte(expected)) {
-		t.Errorf("expected json to be %q, got %q", expected, string(data))
+		t.Errorf(ErrExpectedJSONString, expected, string(data))
 	}
 }
 
@@ -506,22 +517,22 @@ func TestVariable_UnmarshalJSON_UInt32(t *testing.T) {
 
 	var jt JSONType
 	if err := json.Unmarshal(jsonBytes, &jt); err != nil {
-		t.Errorf("failed to unmarshal json with nil types: %s", err)
+		t.Errorf(ErrUnmarshalFailed, err)
 	}
 
 	if jt.Value.IsNil() {
-		t.Errorf("expected value, but got nil")
+		t.Error(ErrExpectedValue)
 	}
 	if jt.NilValue.NotNil() {
-		t.Errorf("expected nil, but got value")
+		t.Error(ErrExpectedNil)
 	}
 	if jt.Value.Value() != expected {
-		t.Errorf("expected value to be %d, got %d", expected, jt.Value.Value())
+		t.Errorf(ErrExpectedJSONInt, expected, jt.Value.Value())
 	}
 
 	jt.Value.Reset()
 	if jt.Value.NotNil() {
-		t.Errorf("expected value to be nil after reset")
+		t.Error(ErrExpectedNilReset)
 	}
 }
 
@@ -537,10 +548,10 @@ func TestVariable_MarshalJSON_UInt32(t *testing.T) {
 	}
 	data, err := json.Marshal(&jt)
 	if err != nil {
-		t.Errorf("failed to marshal json with nil types: %s", err)
+		t.Errorf(ErrMarshalFailed, err)
 	}
 	if !bytes.Equal(data, []byte(expected)) {
-		t.Errorf("expected json to be %q, got %q", expected, string(data))
+		t.Errorf(ErrExpectedJSONString, expected, string(data))
 	}
 }
 
@@ -553,22 +564,22 @@ func TestVariable_UnmarshalJSON_UInt64(t *testing.T) {
 
 	var jt JSONType
 	if err := json.Unmarshal(jsonBytes, &jt); err != nil {
-		t.Errorf("failed to unmarshal json with nil types: %s", err)
+		t.Errorf(ErrUnmarshalFailed, err)
 	}
 
 	if jt.Value.IsNil() {
-		t.Errorf("expected value, but got nil")
+		t.Error(ErrExpectedValue)
 	}
 	if jt.NilValue.NotNil() {
-		t.Errorf("expected nil, but got value")
+		t.Error(ErrExpectedNil)
 	}
 	if jt.Value.Value() != expected {
-		t.Errorf("expected value to be %d, got %d", expected, jt.Value.Value())
+		t.Errorf(ErrExpectedJSONInt, expected, jt.Value.Value())
 	}
 
 	jt.Value.Reset()
 	if jt.Value.NotNil() {
-		t.Errorf("expected value to be nil after reset")
+		t.Error(ErrExpectedNilReset)
 	}
 }
 
@@ -584,10 +595,32 @@ func TestVariable_MarshalJSON_UInt64(t *testing.T) {
 	}
 	data, err := json.Marshal(&jt)
 	if err != nil {
-		t.Errorf("failed to marshal json with nil types: %s", err)
+		t.Errorf(ErrMarshalFailed, err)
 	}
 	if !bytes.Equal(data, []byte(expected)) {
-		t.Errorf("expected json to be %q, got %q", expected, string(data))
+		t.Errorf(ErrExpectedJSONString, expected, string(data))
+	}
+}
+
+func TestVariable_Omitted(t *testing.T) {
+	type JSONType struct {
+		NilValue NilBoolean `json:"nilvalue"`
+		Omitted  NilBoolean `json:"omitted,omitempty"`
+	}
+
+	var jt JSONType
+	if err := json.Unmarshal(jsonBytes, &jt); err != nil {
+		t.Errorf(ErrUnmarshalFailed, err)
+	}
+
+	if jt.NilValue.NotNil() {
+		t.Error(ErrExpectedNil)
+	}
+	if jt.NilValue.Omitted() {
+		t.Error("expected nil value to be not omitted")
+	}
+	if !jt.Omitted.Omitted() {
+		t.Error("expected omitted value to be omitted")
 	}
 }
 

sonar-project.properties

@@ -0,0 +1,6 @@
+# SPDX-FileCopyrightText: 2024 Winni Neessen <wn@neessen.dev>
+#
+# SPDX-License-Identifier: CC0-1.0
+
+sonar.projectKey=niljson
+sonar.go.coverage.reportPaths=cov.out