|
| 1 | +// Copyright (c) Microsoft Corporation. |
| 2 | +// Licensed under the MIT License. |
| 3 | + |
| 4 | +package projectconfig_test |
| 5 | + |
| 6 | +import ( |
| 7 | + "reflect" |
| 8 | + "testing" |
| 9 | + |
| 10 | + "github.com/microsoft/azure-linux-dev-tools/internal/projectconfig" |
| 11 | + "github.com/stretchr/testify/assert" |
| 12 | +) |
| 13 | + |
| 14 | +// TestAllFingerprintedFieldsHaveDecision verifies that every field in every |
| 15 | +// fingerprinted struct has been consciously categorized as either included |
| 16 | +// (no fingerprint tag) or excluded (`fingerprint:"-"`). |
| 17 | +// |
| 18 | +// This test serves two purposes: |
| 19 | +// 1. It ensures that newly added fields default to **included** in the fingerprint |
| 20 | +// (the safe default — you get a false positive, never a false negative). |
| 21 | +// 2. It catches accidental removal of `fingerprint:"-"` tags from excluded fields, |
| 22 | +// since all exclusions are tracked in expectedExclusions. |
| 23 | +func TestAllFingerprintedFieldsHaveDecision(t *testing.T) { |
| 24 | + // All struct types whose fields participate in component fingerprinting. |
| 25 | + // When adding a new struct that feeds into the fingerprint, add it here. |
| 26 | + fingerprintedStructs := []reflect.Type{ |
| 27 | + reflect.TypeFor[projectconfig.ComponentConfig](), |
| 28 | + reflect.TypeFor[projectconfig.ComponentBuildConfig](), |
| 29 | + reflect.TypeFor[projectconfig.CheckConfig](), |
| 30 | + reflect.TypeFor[projectconfig.ComponentBuildFailureConfig](), |
| 31 | + reflect.TypeFor[projectconfig.ComponentBuildHints](), |
| 32 | + reflect.TypeFor[projectconfig.ComponentOverlay](), |
| 33 | + reflect.TypeFor[projectconfig.SpecSource](), |
| 34 | + reflect.TypeFor[projectconfig.DistroReference](), |
| 35 | + reflect.TypeFor[projectconfig.SourceFileReference](), |
| 36 | + reflect.TypeFor[projectconfig.Origin](), |
| 37 | + } |
| 38 | + |
| 39 | + // Maps "StructName.FieldName" for every field that should carry a |
| 40 | + // `fingerprint:"-"` tag. Catches accidental tag removal. |
| 41 | + // |
| 42 | + // Each entry documents WHY the field is excluded from the fingerprint: |
| 43 | + expectedExclusions := map[string]bool{ |
| 44 | + // ComponentConfig.Name — metadata, already the map key in project config. |
| 45 | + "ComponentConfig.Name": true, |
| 46 | + // ComponentConfig.SourceConfigFile — internal bookkeeping reference, not a build input. |
| 47 | + "ComponentConfig.SourceConfigFile": true, |
| 48 | + |
| 49 | + // ComponentBuildConfig.Failure — CI policy (expected failure tracking), not a build input. |
| 50 | + "ComponentBuildConfig.Failure": true, |
| 51 | + // ComponentBuildConfig.Hints — scheduling hints (e.g. expensive), not a build input. |
| 52 | + "ComponentBuildConfig.Hints": true, |
| 53 | + |
| 54 | + // CheckConfig.SkipReason — human documentation for why check is skipped, not a build input. |
| 55 | + "CheckConfig.SkipReason": true, |
| 56 | + |
| 57 | + // ComponentBuildFailureConfig — entire struct excluded via parent, but individual |
| 58 | + // fields are also tagged so reflection on the struct alone is consistent. |
| 59 | + // ComponentBuildFailureConfig.Expected — CI decision about expected failures. |
| 60 | + "ComponentBuildFailureConfig.Expected": true, |
| 61 | + // ComponentBuildFailureConfig.ExpectedReason — documentation for expected failure. |
| 62 | + "ComponentBuildFailureConfig.ExpectedReason": true, |
| 63 | + |
| 64 | + // ComponentBuildHints — entire struct excluded via parent, fields also tagged. |
| 65 | + // ComponentBuildHints.Expensive — scheduling hint, does not affect build output. |
| 66 | + "ComponentBuildHints.Expensive": true, |
| 67 | + |
| 68 | + // ComponentOverlay.Description — human-readable documentation for the overlay. |
| 69 | + "ComponentOverlay.Description": true, |
| 70 | + |
| 71 | + // SourceFileReference.Component — back-reference to parent, not a build input. |
| 72 | + "SourceFileReference.Component": true, |
| 73 | + |
| 74 | + // DistroReference.Snapshot — snapshot timestamp is not a build input; the resolved |
| 75 | + // upstream commit hash (captured separately via SourceIdentity) is what matters. |
| 76 | + // Excluding this prevents a snapshot bump from marking all upstream components as changed. |
| 77 | + "DistroReference.Snapshot": true, |
| 78 | + |
| 79 | + // SourceFileReference.Origin — download location metadata (URI, type), not a build input. |
| 80 | + // The file content is already captured by Filename + Hash; changing a CDN URL should not |
| 81 | + // trigger a rebuild. |
| 82 | + "SourceFileReference.Origin": true, |
| 83 | + } |
| 84 | + |
| 85 | + // Collect all actual exclusions found via reflection. |
| 86 | + actualExclusions := make(map[string]bool) |
| 87 | + |
| 88 | + for _, st := range fingerprintedStructs { |
| 89 | + for i := range st.NumField() { |
| 90 | + field := st.Field(i) |
| 91 | + key := st.Name() + "." + field.Name |
| 92 | + |
| 93 | + tag := field.Tag.Get("fingerprint") |
| 94 | + if tag == "-" { |
| 95 | + actualExclusions[key] = true |
| 96 | + } |
| 97 | + } |
| 98 | + } |
| 99 | + |
| 100 | + // Verify every expected exclusion is actually present. |
| 101 | + for key := range expectedExclusions { |
| 102 | + assert.Truef(t, actualExclusions[key], |
| 103 | + "expected field %q to have `fingerprint:\"-\"` tag, but it does not — "+ |
| 104 | + "was the tag accidentally removed?", key) |
| 105 | + } |
| 106 | + |
| 107 | + // Verify no unexpected exclusions exist. |
| 108 | + for key := range actualExclusions { |
| 109 | + assert.Truef(t, expectedExclusions[key], |
| 110 | + "field %q has `fingerprint:\"-\"` tag but is not in expectedExclusions — "+ |
| 111 | + "add it to expectedExclusions if the exclusion is intentional", key) |
| 112 | + } |
| 113 | +} |
0 commit comments