mask/rule_names_test.go at main · axonops/mask · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
// Copyright 2026 AxonOps Limited.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package mask_test

import (
	"sort"
	"testing"

	"github.com/stretchr/testify/assert"

	"github.com/axonops/mask"
)

// ruleNameConstants lists every exported `mask.Rule*` constant in the
// library. The drift-guard test below asserts this set matches
// `mask.Rules()` exactly, so a new built-in rule without a matching
// constant — or a removed constant still referenced in the registry —
// fails the build.
var ruleNameConstants = []string{
	// Utility primitives
	mask.RuleFullRedact,
	mask.RuleSameLengthMask,
	mask.RuleNullify,
	mask.RuleDeterministicHash,
	// Global identity
	mask.RuleEmailAddress,
	mask.RulePersonName,
	mask.RuleGivenName,
	mask.RuleFamilyName,
	mask.RuleStreetAddress,
	mask.RuleDateOfBirth,
	mask.RuleUsername,
	mask.RulePassportNumber,
	mask.RuleDriverLicenseNumber,
	mask.RuleGenericNationalID,
	mask.RuleTaxIdentifier,
	// Country-specific identity
	mask.RuleUSSSN,
	mask.RuleCASIN,
	mask.RuleUKNINO,
	mask.RuleINAadhaar,
	mask.RuleINPAN,
	mask.RuleAUMedicareNumber,
	mask.RuleSGNRICFIN,
	mask.RuleBRCPF,
	mask.RuleBRCNPJ,
	mask.RuleMXCURP,
	mask.RuleMXRFC,
	mask.RuleCNResidentID,
	mask.RuleZANationalID,
	mask.RuleESDNINIFNIE,
	// Financial
	mask.RulePaymentCardPAN,
	mask.RulePaymentCardPANFirst6,
	mask.RulePaymentCardPANLast4,
	mask.RulePaymentCardCVV,
	mask.RulePaymentCardPIN,
	mask.RuleBankAccountNumber,
	mask.RuleUKSortCode,
	mask.RuleUSABARoutingNumber,
	mask.RuleIBAN,
	mask.RuleSWIFTBIC,
	mask.RuleMonetaryAmount,
	// Health
	mask.RuleMedicalRecordNumber,
	mask.RuleHealthPlanBeneficiaryID,
	mask.RuleMedicalDeviceIdentifier,
	mask.RuleDiagnosisCode,
	mask.RulePrescriptionText,
	// Technology
	mask.RuleIPv4Address,
	mask.RuleIPv6Address,
	mask.RuleMACAddress,
	mask.RuleHostname,
	mask.RuleURL,
	mask.RuleURLCredentials,
	mask.RuleAPIKey,
	mask.RuleJWTToken,
	mask.RuleBearerToken,
	mask.RulePassword,
	mask.RulePrivateKeyPEM,
	mask.RuleConnectionString,
	mask.RuleDatabaseDSN,
	mask.RuleUUID,
	// Telecom
	mask.RulePhoneNumber,
	mask.RuleMobilePhoneNumber,
	mask.RuleIMEI,
	mask.RuleIMSI,
	mask.RuleMSISDN,
	// Location
	mask.RulePostalCode,
	mask.RuleGeoLatitude,
	mask.RuleGeoLongitude,
	mask.RuleGeoCoordinates,
}

// TestRuleNameConstants_MatchRegistry asserts that the exported
// constants cover exactly the set of built-in rules registered on a
// fresh Masker. A mismatch in either direction fails the build.
func TestRuleNameConstants_MatchRegistry(t *testing.T) {
	t.Parallel()
	m := mask.New()
	registered := m.Rules()
	sort.Strings(registered)

	declared := make([]string, len(ruleNameConstants))
	copy(declared, ruleNameConstants)
	sort.Strings(declared)

	assert.Equal(t, registered, declared,
		"exported Rule* constants must match the built-in registry one-for-one")
}