schema_test.go

// This file is part of Arduino Lint.
//
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
//
// This software is released under the GNU General Public License, either
// version 3 of the License, or (at your option) any later version.
// This license covers the main part of Arduino Lint.
// The terms of this license can be found at:
// https://www.gnu.org/licenses/gpl-3.0.en.html
//
// You can be released from the requirements of the above licenses by purchasing
// a commercial license. Buying such a license is mandatory if you want to
// modify or otherwise use the software for commercial activities involving the
// Arduino software without disclosing the source code of your own applications.
// To purchase a commercial license, send an email to license@arduino.cc.

package schema

import (
	"encoding/json"
	"fmt"
	"regexp"
	"testing"

	"github.com/arduino/arduino-lint/internal/project/general"
	"github.com/arduino/arduino-lint/internal/rule/schema/testdata"
	"github.com/arduino/go-properties-orderedmap"
	"github.com/ory/jsonschema/v3"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"github.com/xeipuuv/gojsonpointer"
)

var validMap = map[string]string{
	"property1":          "foo",
	"property2":          "bar",
	"property3":          "baz",
	"dependentProperty":  "asdf",
	"dependencyProperty": "zxcv",
}

var validPropertiesMap = properties.NewFromHashmap(validMap)

var validSchemaWithReferences Schema

func init() {
	validSchemaWithReferences = Compile(
		"valid-schema-with-references.json",
		[]string{
			"referenced-schema-1.json",
			"referenced-schema-2.json",
		},
		testdata.Asset,
	)
}

func TestCompile(t *testing.T) {
	assert.Panics(t, func() {
		Compile("valid-schema-with-references.json", []string{"nonexistent.json"}, testdata.Asset)
	})

	assert.Panics(t, func() {
		Compile("valid-schema-with-references.json", []string{"schema-without-id.json"}, testdata.Asset)
	})

	assert.Panics(t, func() {
		Compile("invalid-schema.json", []string{}, testdata.Asset)
	})

	assert.Panics(t, func() {
		Compile("valid-schema-with-references.json", []string{}, testdata.Asset)
	})

	assert.NotPanics(t, func() {
		Compile("valid-schema.json", []string{}, testdata.Asset)
	})

	assert.NotPanics(t, func() {
		Compile(
			"valid-schema-with-references.json",
			[]string{
				"referenced-schema-1.json",
				"referenced-schema-2.json",
			},
			testdata.Asset,
		)
	})
}

func TestValidate(t *testing.T) {
	schemaObject := Compile("valid-schema.json", []string{}, testdata.Asset)
	propertiesMap := properties.NewFromHashmap(validMap)
	validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), schemaObject)
	assert.Nil(t, validationResult.Result)

	validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.Nil(t, validationResult.Result)

	propertiesMap.Set("property1", "a")
	validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), schemaObject)
	assert.Equal(t, "#/property1", validationResult.Result.InstancePtr)
	assert.Equal(t, "#/properties/property1/minLength", validationResult.Result.SchemaPtr)
}

func TestRequiredPropertyMissing(t *testing.T) {
	propertiesMap := properties.NewFromHashmap(validMap)
	validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.False(t, RequiredPropertyMissing("property1", validationResult))

	propertiesMap.Remove("property1")
	validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.True(t, RequiredPropertyMissing("property1", validationResult))
}

func TestPropertyPatternMismatch(t *testing.T) {
	propertiesMap := properties.NewFromHashmap(validMap)
	validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.False(t, PropertyPatternMismatch("property2", validationResult))

	propertiesMap.Set("property2", "fOo")
	validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.True(t, PropertyPatternMismatch("property2", validationResult))

	assert.False(t, PropertyPatternMismatch("property1", validationResult))
}

func TestPropertyLessThanMinLength(t *testing.T) {
	propertiesMap := properties.NewFromHashmap(validMap)
	validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.False(t, PropertyLessThanMinLength("property1", validationResult))

	propertiesMap.Set("property1", "a")
	validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.True(t, PropertyLessThanMinLength("property1", validationResult))
}

func TestPropertyGreaterThanMaxLength(t *testing.T) {
	propertiesMap := properties.NewFromHashmap(validMap)
	validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.False(t, PropertyGreaterThanMaxLength("property1", validationResult))

	propertiesMap.Set("property1", "12345")
	validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.True(t, PropertyGreaterThanMaxLength("property1", validationResult))
}

func TestPropertyEnumMismatch(t *testing.T) {
	propertiesMap := properties.NewFromHashmap(validMap)
	validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.False(t, PropertyEnumMismatch("property3", validationResult))

	propertiesMap.Set("property3", "invalid")
	validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.True(t, PropertyEnumMismatch("property3", validationResult))
}

func TestPropertyTypeMismatch(t *testing.T) {
	propertyName := "TestPropertyTypeMismatch"
	instanceTemplate := `
{
	"%s": "foo"
}
`
	rawInstance := fmt.Sprintf(instanceTemplate, propertyName)
	var instance map[string]interface{}
	json.Unmarshal([]byte(rawInstance), &instance)

	assert.False(t, PropertyTypeMismatch(propertyName, Validate(instance, validSchemaWithReferences)), "Property type is correct")

	// Change property to incorrect type.
	pointerString := "/" + propertyName
	pointer, err := gojsonpointer.NewJsonPointer(pointerString)
	require.NoError(t, err)
	_, err = pointer.Set(instance, 1)
	require.NoError(t, err)

	assert.True(t, PropertyTypeMismatch(propertyName, Validate(instance, validSchemaWithReferences)), "Property type is incorrect")
}

func TestPropertyFormatMismatch(t *testing.T) {
	propertyName := "TestPropertyFormatMismatch"
	instanceTemplate := `
{
	"%s": "http://example.com"
}
`
	rawInstance := fmt.Sprintf(instanceTemplate, propertyName)
	var instance map[string]interface{}
	json.Unmarshal([]byte(rawInstance), &instance)

	assert.False(t, PropertyFormatMismatch(propertyName, Validate(instance, validSchemaWithReferences)), "Property format is correct")

	// Change property to incorrect type.
	pointerString := "/" + propertyName
	pointer, err := gojsonpointer.NewJsonPointer(pointerString)
	require.NoError(t, err)
	_, err = pointer.Set(instance, "foo")
	require.NoError(t, err)

	assert.True(t, PropertyFormatMismatch(propertyName, Validate(instance, validSchemaWithReferences)), "Property format is incorrect")
}

func TestProhibitedAdditionalProperties(t *testing.T) {
	propertyName := "TestProhibitedAdditionalProperties"
	instanceTemplate := `
{
	"%s": {
		"additionalPropertiesTrue": {
			"fooProperty": "bar"
		},
		"additionalPropertiesFalse": {
			"fooProperty": "bar"
		}
	}
}
`

	testTables := []struct {
		objectPointerString string
		assertion           assert.BoolAssertionFunc
	}{
		{"/TestProhibitedAdditionalProperties/additionalPropertiesTrue", assert.False},
		{"/TestProhibitedAdditionalProperties/additionalPropertiesFalse", assert.True},
	}

	for _, testTable := range testTables {
		rawInstance := fmt.Sprintf(instanceTemplate, propertyName)
		var instance map[string]interface{}
		json.Unmarshal([]byte(rawInstance), &instance)

		assert.False(t, ProhibitedAdditionalProperties(testTable.objectPointerString, Validate(instance, validSchemaWithReferences)), fmt.Sprintf("No additional properties in %s", testTable.objectPointerString))

		// Add additional property to object.
		pointer, err := gojsonpointer.NewJsonPointer(testTable.objectPointerString + "/fooAdditionalProperty")
		require.NoError(t, err)
		_, err = pointer.Set(instance, "bar")
		require.NoError(t, err)

		t.Run(fmt.Sprintf("Additional property in the %s object", testTable.objectPointerString), func(t *testing.T) {
			testTable.assertion(t, ProhibitedAdditionalProperties(testTable.objectPointerString, Validate(instance, validSchemaWithReferences)))
		})
	}
}

func TestPropertyDependenciesMissing(t *testing.T) {
	propertiesMap := properties.NewFromHashmap(validMap)
	validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.False(t, PropertyDependenciesMissing("dependentProperty", validationResult))

	propertiesMap.Remove("dependencyProperty")
	validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.True(t, PropertyDependenciesMissing("dependentProperty", validationResult))
}

func TestMisspelledOptionalPropertyFound(t *testing.T) {
	propertiesMap := properties.NewFromHashmap(validMap)
	validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.False(t, MisspelledOptionalPropertyFound(validationResult))

	propertiesMap.Set("porperties", "foo")
	validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.True(t, MisspelledOptionalPropertyFound(validationResult))
}

func TestValidationErrorMatch(t *testing.T) {
	propertiesMap := properties.NewFromHashmap(validMap)
	validationResult := Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.False(t, ValidationErrorMatch("", "", "", "", validationResult))

	propertiesMap.Set("property2", "fOo")
	validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.False(t, ValidationErrorMatch("nomatch", "nomatch", "nomatch", "nomatch", validationResult))
	assert.False(t, ValidationErrorMatch("^#/property2$", "nomatch", "nomatch", "nomatch", validationResult))
	assert.False(t, ValidationErrorMatch("^#/property2$", "/pattern$", "nomatch", "nomatch", validationResult))
	assert.False(t, ValidationErrorMatch("^#/property2$", "/pattern$", `^\^\[a-z\]\+\$$`, "nomatch", validationResult))
	assert.True(t, ValidationErrorMatch("^#/property2$", "/pattern$", `^"\^\[a-z\]\+\$"$`, "", validationResult))
	assert.True(t, ValidationErrorMatch("", "", "", "", validationResult))

	propertiesMap.Set("property3", "bAz")
	validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.True(t, ValidationErrorMatch("^#/property3$", "/pattern$", "", "", validationResult), "Match pointer below logic inversion keyword")

	propertiesMap = properties.NewFromHashmap(validMap)
	propertiesMap.Remove("property1")
	validationResult = Validate(general.PropertiesToMap(propertiesMap, 0), validSchemaWithReferences)
	assert.False(t, ValidationErrorMatch("nomatch", "nomatch", "nomatch", "nomatch", validationResult))
	assert.True(t, ValidationErrorMatch("", "", "", "^#/property1$", validationResult))
}

func Test_loadReferencedSchema(t *testing.T) {
	compiler := jsonschema.NewCompiler()

	assert.Panics(
		t,
		func() {
			loadReferencedSchema(compiler, "nonexistent.json", testdata.Asset)
		},
	)
	assert.Error(t, loadReferencedSchema(compiler, "schema-without-id.json", testdata.Asset))
	assert.Nil(t, loadReferencedSchema(compiler, "referenced-schema-2.json", testdata.Asset))
}

func Test_schemaID(t *testing.T) {
	_, err := schemaID("schema-without-id.json", testdata.Asset)
	assert.NotNil(t, err)

	id, err := schemaID("valid-schema.json", testdata.Asset)
	require.Nil(t, err)
	assert.Equal(t, "https://raw-hub.myxuebi.top/arduino/arduino-lint/main/internal/rule/schema/testdata/input/valid-schema.json", id)
}

func Test_validationErrorSchemaPointerValue(t *testing.T) {
	validationError := ValidationResult{
		Result: &jsonschema.ValidationError{
			SchemaURL: "https://raw-hub.myxuebi.top/arduino/arduino-lint/main/internal/rule/schema/testdata/referenced-schema-1.json",
			SchemaPtr: "#/definitions/patternObject/pattern",
		},
		dataLoader: testdata.Asset,
	}

	schemaPointerValueInterface := validationErrorSchemaPointerValue(validationError)
	schemaPointerValue, ok := schemaPointerValueInterface.(string)
	assert.True(t, ok)
	assert.Equal(t, "^[a-z]+$", schemaPointerValue)
}

func Test_validationErrorContextMatch(t *testing.T) {
	validationError := jsonschema.ValidationError{
		Context: nil,
	}

	assert.True(t, validationErrorContextMatch(regexp.MustCompile(".*"), &validationError))
	assert.False(t, validationErrorContextMatch(regexp.MustCompile("foo"), &validationError))

	validationError.Context = &jsonschema.ValidationErrorContextRequired{
		Missing: []string{
			"#/foo",
			"#/bar",
		},
	}

	assert.True(t, validationErrorContextMatch(regexp.MustCompile("^#/bar$"), &validationError))
	assert.False(t, validationErrorContextMatch(regexp.MustCompile("nomatch"), &validationError))
}