path_specified_add_test.go

package scimpatch_test

import (
	"context"
	"fmt"
	"testing"

	"github.com/elimity-com/scim"
	"github.com/elimity-com/scim/schema"
	scimpatch "github.com/ivixvi/scim-patch"
)

// TestPathSpecifiedAdd は Patcher.Apply の path指定をしているadd操作の正常系をテストします
func TestPathSpecifiedAdd(t *testing.T) {
	// Define the test cases
	testCases := []struct {
		name            string
		op              scim.PatchOperation
		data            map[string]interface{}
		expected        map[string]interface{}
		expectedChanged bool
	}{
		// Singular Attribute
		{
			name: "Add operation - Core Singular Attributes - add",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path(`displayName`),
				Value: "Alice Green",
			},
			data: map[string]interface{}{},
			expected: map[string]interface{}{
				"displayName": "Alice Green",
			},
			expectedChanged: true,
		},
		{
			name: "Add operation - Core Singular Attributes - replace",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path(`displayName`),
				Value: "Alice Green",
			},
			data: map[string]interface{}{
				"displayName": "Bob Green",
			},
			expected: map[string]interface{}{
				"displayName": "Alice Green",
			},
			expectedChanged: true,
		},
		{
			name: "Add operation - Core Singular Attributes - no changed",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path(`displayName`),
				Value: "Alice Green",
			},
			data: map[string]interface{}{
				"displayName": "Alice Green",
			},
			expected: map[string]interface{}{
				"displayName": "Alice Green",
			},
			expectedChanged: false,
		},
		// Extension Singular Attribute
		{
			name: "Add operation - Extension Singular Attributes - add",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path(`urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department`),
				Value: "Sales",
			},
			data: map[string]interface{}{},
			expected: map[string]interface{}{
				"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": map[string]interface{}{
					"department": "Sales",
				},
			},
			expectedChanged: true,
		},
		{
			name: "Add operation - Extension Singular Attributes - add",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path(`urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department`),
				Value: "2B Sales",
			},
			data: map[string]interface{}{
				"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": map[string]interface{}{
					"division": "Sales",
				},
			},
			expected: map[string]interface{}{
				"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": map[string]interface{}{
					"department": "2B Sales",
					"division":   "Sales",
				},
			},
			expectedChanged: true,
		},
		{
			name: "Add operation - Extension Singular Attributes - replace",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path(`urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department`),
				Value: "2B Sales",
			},
			data: map[string]interface{}{
				"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": map[string]interface{}{
					"department": "2C Sales",
					"division":   "Sales",
				},
			},
			expected: map[string]interface{}{
				"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": map[string]interface{}{
					"department": "2B Sales",
					"division":   "Sales",
				},
			},
			expectedChanged: true,
		},
		{
			name: "Add operation - Extension Singular Attributes - no changed",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path(`urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department`),
				Value: "2B Sales",
			},
			data: map[string]interface{}{
				"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": map[string]interface{}{
					"division": "Sales",
				},
			},
			expected: map[string]interface{}{
				"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": map[string]interface{}{
					"department": "2B Sales",
					"division":   "Sales",
				},
			},
			expectedChanged: true,
		},
		// Complex Attribute
		{
			name: "Add operation - Core Complex Attributes - replace",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path(`name.familyName`),
				Value: "Green",
			},
			data: map[string]interface{}{
				"name": map[string]interface{}{
					"familyName": "Blue",
					"givenName":  "Alice",
				},
			},
			expected: map[string]interface{}{
				"name": map[string]interface{}{
					"familyName": "Green",
					"givenName":  "Alice",
				},
			},
			expectedChanged: true,
		},
		{
			name: "Add operation - Core Complex Attributes - no value",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path(`name.familyName`),
				Value: "Green",
			},
			data: map[string]interface{}{
				"name": map[string]interface{}{
					"givenName": "Alice",
				},
			},
			expected: map[string]interface{}{
				"name": map[string]interface{}{
					"familyName": "Green",
					"givenName":  "Alice",
				},
			},
			expectedChanged: true,
		},
		{
			name: "Add operation - Core Complex Attributes - no changed.",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path(`name.familyName`),
				Value: "Green",
			},
			data: map[string]interface{}{
				"name": map[string]interface{}{
					"familyName": "Green",
					"givenName":  "Alice",
				},
			},
			expected: map[string]interface{}{
				"name": map[string]interface{}{
					"familyName": "Green",
					"givenName":  "Alice",
				},
			},
			expectedChanged: false,
		},
		{
			name: "Add operation - Core Complex Attributes - map specified merge",
			op: scim.PatchOperation{
				Op:   "add",
				Path: path(`name`),
				Value: map[string]interface{}{
					"givenName": "Alice",
					"formatted": "Alice Green",
				},
			},
			data: map[string]interface{}{
				"name": map[string]interface{}{
					"familyName": "Green",
					"formatted":  "Bob Green",
				},
			},
			expected: map[string]interface{}{
				"name": map[string]interface{}{
					"familyName": "Green",
					"givenName":  "Alice",
					"formatted":  "Alice Green",
				},
			},
			expectedChanged: true,
		},
		{
			name: "Add operation - Core Singular Attributes - map specified no changed",
			op: scim.PatchOperation{
				Op:   "add",
				Path: path(`name`),
				Value: map[string]interface{}{
					"familyName": "Green",
					"givenName":  "Alice",
				},
			},
			data: map[string]interface{}{
				"name": map[string]interface{}{
					"familyName": "Green",
					"givenName":  "Alice",
				},
			},
			expected: map[string]interface{}{
				"name": map[string]interface{}{
					"familyName": "Green",
					"givenName":  "Alice",
				},
			},
			expectedChanged: false,
		},
		// MultiValued Complex Attribute
		{
			name: "Add operation - Core MultiValued Complex Attributes - Add All",
			op: scim.PatchOperation{
				Op:   "add",
				Path: path(`emails`),
				Value: []interface{}{
					map[string]interface{}{
						"type":  "work",
						"value": "ivixvi-added@example.com",
					},
				},
			},
			data: map[string]interface{}{
				"emails": []interface{}{
					map[string]interface{}{
						"type":  "home",
						"value": "ivixvi@example.com",
					},
				},
			},
			expected: map[string]interface{}{
				"emails": []interface{}{
					map[string]interface{}{
						"type":  "home",
						"value": "ivixvi@example.com",
					},
					map[string]interface{}{
						"type":  "work",
						"value": "ivixvi-added@example.com",
					},
				},
			},
			expectedChanged: true,
		},
		{
			name: "Add operation - Core MultiValued Complex Attributes - Add All no changed",
			op: scim.PatchOperation{
				Op:   "add",
				Path: path(`emails`),
				Value: []interface{}{
					map[string]interface{}{
						"type":  "work",
						"value": "ivixvi-added@example.com",
					},
				},
			},
			data: map[string]interface{}{
				"emails": []interface{}{
					map[string]interface{}{
						"type":  "home",
						"value": "ivixvi@example.com",
					},
					map[string]interface{}{
						"type":  "work",
						"value": "ivixvi-added@example.com",
					},
				},
			},
			expected: map[string]interface{}{
				"emails": []interface{}{
					map[string]interface{}{
						"type":  "home",
						"value": "ivixvi@example.com",
					},
					map[string]interface{}{
						"type":  "work",
						"value": "ivixvi-added@example.com",
					},
				},
			},
			expectedChanged: false,
		},
		{
			name: "Add operation - Core MultiValued Complex Attributes - Add For Item",
			op: scim.PatchOperation{
				Op:   "add",
				Path: path(`emails[type eq "work"]`),
				Value: map[string]interface{}{
					"type":    "work",
					"value":   "ivixvi-updated@example.com",
					"primary": true,
				},
			},
			data: map[string]interface{}{
				"emails": []interface{}{
					map[string]interface{}{
						"type":  "work",
						"value": "ivixvi@example.com",
					},
				},
			},
			expected: map[string]interface{}{
				"emails": []interface{}{
					map[string]interface{}{
						"type":    "work",
						"value":   "ivixvi-updated@example.com",
						"primary": true,
					},
				},
			},
			expectedChanged: true,
		},
		{
			name: "Add operation - Core MultiValued Complex Attributes - Add For Item no changed",
			op: scim.PatchOperation{
				Op:   "add",
				Path: path(`emails[type eq "work"]`),
				Value: map[string]interface{}{
					"type":  "work",
					"value": "ivixvi@example.com",
				},
			},
			data: map[string]interface{}{
				"emails": []interface{}{
					map[string]interface{}{
						"type":  "work",
						"value": "ivixvi@example.com",
					},
				},
			},
			expected: map[string]interface{}{
				"emails": []interface{}{
					map[string]interface{}{
						"type":  "work",
						"value": "ivixvi@example.com",
					},
				},
			},
			expectedChanged: false,
		},
		{
			name: "Add operation - Core MultiValued Complex Attributes - Replace For Attribute",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path(`emails[type eq "work"].value`),
				Value: "ivixvi-updated@example.com",
			},
			data: map[string]interface{}{
				"emails": []interface{}{
					map[string]interface{}{
						"type":  "work",
						"value": "ivixvi@example.com",
					},
				},
			},
			expected: map[string]interface{}{
				"emails": []interface{}{
					map[string]interface{}{
						"type":  "work",
						"value": "ivixvi-updated@example.com",
					},
				},
			},
			expectedChanged: true,
		},
		{
			name: "Add operation - Core MultiValued Complex Attributes - Replace For Attribute no changed",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path(`emails[type eq "work"].value`),
				Value: "ivixvi@example.com",
			},
			data: map[string]interface{}{
				"emails": []interface{}{
					map[string]interface{}{
						"type":  "work",
						"value": "ivixvi@example.com",
					},
				},
			},
			expected: map[string]interface{}{
				"emails": []interface{}{
					map[string]interface{}{
						"type":  "work",
						"value": "ivixvi@example.com",
					},
				},
			},
			expectedChanged: false,
		},
		{
			name: "Add operation - MultiValued Complex Attributes - Filter & Value addition",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path(`emails[type eq "work"].value`),
				Value: "ivixvi@example.com",
			},
			data: map[string]interface{}{},
			expected: map[string]interface{}{
				"emails": []interface{}{
					map[string]interface{}{
						"type":  "work",
						"value": "ivixvi@example.com",
					},
				},
			},
			expectedChanged: true,
		},
		// MultiValued Attribute
		{
			name: "Add operation - Extension MultiValued Attributes - new value",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path("urn:ivixvi:testSchema:testString"),
				Value: "value",
			},
			data: map[string]interface{}{},
			// FIXME: schema is not validated
			expected: map[string]interface{}{
				"urn:ivixvi:testSchema": map[string]interface{}{
					// "testString": []interface{}{"value"},
					"testString": "value",
				},
			},
			expectedChanged: true,
		},
		{
			name: "Add operation - Extension MultiValued Attributes - add value",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path("urn:ivixvi:testSchema:testString"),
				Value: "newValue",
			},
			data: map[string]interface{}{
				"urn:ivixvi:testSchema": map[string]interface{}{
					"testString": []interface{}{"value"},
				},
			},
			// FIXME: schema is not validated
			expected: map[string]interface{}{
				"urn:ivixvi:testSchema": map[string]interface{}{
					// "testString": []interface{}{"value", "newValue"},
					"testString": "newValue",
				},
			},
			expectedChanged: true,
		},
		{
			name: "Add operation - Extension MultiValued Attributes - no changed",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path("urn:ivixvi:testSchema:testString"),
				Value: "value",
			},
			data: map[string]interface{}{
				"urn:ivixvi:testSchema": map[string]interface{}{
					"testString": []interface{}{"value"},
				},
			},
			// FIXME: schema is not validated
			expected: map[string]interface{}{
				"urn:ivixvi:testSchema": map[string]interface{}{
					// "testString": []interface{}{"value"},
					"testString": "value",
				},
			},
			// expectedChanged: false,
			expectedChanged: true,
		},
		{
			name: "Add operation - Extension MultiValued Attributes - slice specified new value",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path("urn:ivixvi:testSchema:testString"),
				Value: []interface{}{"value"},
			},
			data: map[string]interface{}{},
			expected: map[string]interface{}{
				"urn:ivixvi:testSchema": map[string]interface{}{
					"testString": []interface{}{"value"},
				},
			},
			expectedChanged: true,
		},
		{
			name: "Add operation - Extension MultiValued Attributes - slice specified add value",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path("urn:ivixvi:testSchema:testString"),
				Value: []interface{}{"newValue"},
			},
			data: map[string]interface{}{
				"urn:ivixvi:testSchema": map[string]interface{}{
					"testString": []interface{}{"value"},
				},
			},
			expected: map[string]interface{}{
				"urn:ivixvi:testSchema": map[string]interface{}{
					"testString": []interface{}{"value", "newValue"},
				},
			},
			expectedChanged: true,
		},
		{
			name: "Add operation - Extension MultiValued Attributes - slice specified no changed",
			op: scim.PatchOperation{
				Op:    "add",
				Path:  path("urn:ivixvi:testSchema:testString"),
				Value: []interface{}{"value"},
			},
			data: map[string]interface{}{
				"urn:ivixvi:testSchema": map[string]interface{}{
					"testString": []interface{}{"value"},
				},
			},
			expected: map[string]interface{}{
				"urn:ivixvi:testSchema": map[string]interface{}{
					"testString": []interface{}{"value"},
				},
			},
			expectedChanged: false,
		},
	}

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			t.Log(tc.name)
			// Create a Patcher instance with a dummy schema
			patcher := scimpatch.NewPatcher(
				schema.CoreUserSchema(),
				[]schema.Schema{
					schema.ExtensionEnterpriseUser(),
					TestExtensionSchema,
				}, nil)

			// Apply the PatchOperation
			result, changed, err := patcher.Apply(context.TODO(), tc.op, tc.data)
			if err != nil {
				t.Fatalf("Apply() returned an unexpected error: %v", err)
			}
			// Check if the result matches the expected data
			if changed != tc.expectedChanged {
				t.Errorf("changed:\n    actual  : %v\n    expected: %v", changed, tc.expectedChanged)
			}
			// Check if the result matches the expected data
			if !(fmt.Sprint(result) == fmt.Sprint(tc.expected)) {
				t.Errorf("result:\n    actual  : %v\n    expected: %v", result, tc.expected)
			}
		})
	}
}