fix: Validation handler to include all resourceMetadata when true (#141)

* fix: Valiation handler to include all resourceMetadata when true

* test: Add more unit tests [DEV-2506] (#140)

* Add handling for only did queries and small refactoring

* Makes linter happy

* Add unit tests

* Add basic implementation for resource queries

* Small refactoring

* Add resourceVersion and handler for it

* Makes Linter happy

* Makes linter happy

* Small refactoring

* Fix unit tests for queries

* MAkes linter happy and fix integration tests

* Add more integration tests for queries

* Fixed:
- added version support
- changed logic for allowing versionId and versionTime in the same query
- added more integration tests

* Changed did doc implementation due to the latest changes in doc

* Makes linter happy

* Small validation and refactorings

* Add checksum handling and small improvements

* Fix RequestURI parameter displaying

* Makes linter happy

* Makes linter happy

* Uncomment positive integration tests

* Makes linter happy

* fix swagger build

* Change expected diddoc jsons for integration tests

* Add tests for DidDocMetadataList structure

* Fix PR review comments

* Makes linter happy

* Add tests for dereferencing content stream

* Add more unit tests

* temporary

* Add positive cases for resources and diddocs

* Fix merging with develop

* Fi transformKey tests

* Return DIDDocument if metadata=false

* Return positive tests back

* Add more tests for negative/positive cases

* Remove commented imports

* Review comments

* docs: Reflect DID URL dereferencing changes in swagger (#145)

* Actualize swagger docs

* Fix golangci-lint mistakes.

* Update swagger OpenAPI documentation.

---------

Co-authored-by: abdulla-ashurov <[email protected]>

* Add tests

* Get rid of tests with the same name or resource type.
For now, in case of setting resourceMetadata=true it
behaves as just filter option.

---------

Co-authored-by: Andrew Nikitin <[email protected]>
Co-authored-by: abdulla-ashurov <[email protected]>

Author: 3 people

services/diddoc/queries/resources/resource_validation_handler.go

@@ -14,13 +14,18 @@ type ResourceValidationHandler struct {
 func (d *ResourceValidationHandler) Handle(c services.ResolverContext, service services.RequestServiceI, response types.ResolutionResultI) (types.ResolutionResultI, error) {
 	resourceName := service.GetQueryParam(types.ResourceName)
 	resourceType := service.GetQueryParam(types.ResourceType)
+	resourceMetadata := service.GetQueryParam(types.ResourceMetadata)
 
 	// Cast to just list of resources
 	resourceCollection, err := d.CastToContent(service, response)
 	if err != nil {
 		return nil, err
 	}
 
+	if resourceMetadata == "true" {
+		return d.Continue(c, service, resourceCollection)
+	}
+
 	if resourceType != "" {
 		// If we have 2 or more resources we need to check resource names.
 		// If resource names are the same we need to return the latest.

tests/unit/diddoc/request/resource_negative_metadata_test.go

@@ -252,50 +252,4 @@ var _ = DescribeTable("Test resource negative cases with Metadata field", func(t
 			expectedError: types.NewNotFoundError(testconstants.ValidDid, types.DIDJSONLD, nil, true),
 		},
 	),
-	Entry(
-		"Negative. There are several resources with the same type but different names",
-		ResourceMetadataTestCase{
-			didURL: fmt.Sprintf(
-				"/1.0/identifiers/%s?resourceType=%s&resourceMetadata=true",
-				testconstants.ValidDid,
-				ResourceType1.Metadata.ResourceType,
-			),
-			resolutionType: types.DIDJSONLD,
-			expectedDereferencingResult: &DereferencingResult{
-				DereferencingMetadata: &types.DereferencingMetadata{
-					DidProperties: types.DidProperties{
-						DidString:        testconstants.ExistentDid,
-						MethodSpecificId: testconstants.ValidIdentifier,
-						Method:           testconstants.ValidMethod,
-					},
-				},
-				ContentStream: &types.DereferencedResourceListStruct{},
-				Metadata: &types.ResolutionDidDocMetadata{},
-			},
-			expectedError: types.NewNotFoundError(testconstants.ValidDid, types.DIDJSONLD, nil, true),
-		},
-	),
-	Entry(
-		"Negative. There are several names with the same name but different types",
-		ResourceMetadataTestCase{
-			didURL: fmt.Sprintf(
-				"/1.0/identifiers/%s?resourceName=%s&resourceMetadata=true",
-				testconstants.ValidDid,
-				ResourceType2.Metadata.Name,
-			),
-			resolutionType: types.DIDJSONLD,
-			expectedDereferencingResult: &DereferencingResult{
-				DereferencingMetadata: &types.DereferencingMetadata{
-					DidProperties: types.DidProperties{
-						DidString:        testconstants.ExistentDid,
-						MethodSpecificId: testconstants.ValidIdentifier,
-						Method:           testconstants.ValidMethod,
-					},
-				},
-				ContentStream: &types.DereferencedResourceListStruct{},
-				Metadata: &types.ResolutionDidDocMetadata{},
-			},
-			expectedError: types.NewNotFoundError(testconstants.ValidDid, types.DIDJSONLD, nil, true),
-		},
-	),
 )

tests/unit/diddoc/request/resources_positive_cases_metadata_test.go

@@ -322,4 +322,60 @@ var _ = DescribeTable("Test resource positive cases with Metadata field", func(t
 			expectedError: nil,
 		},
 	),
+	Entry(
+		"Positive. Several resources with the same name",
+		ResourceMetadataTestCase{
+			didURL: fmt.Sprintf(
+				"/1.0/identifiers/%s?resourceName=%s&resourceMetadata=true",
+				testconstants.ValidDid,
+				ResourceName1.Metadata.Name,
+			),
+			resolutionType: types.DIDJSONLD,
+			expectedDereferencingResult: &DereferencingResult{
+				DereferencingMetadata: &types.DereferencingMetadata{
+					DidProperties: types.DidProperties{
+						DidString:        testconstants.ExistentDid,
+						MethodSpecificId: testconstants.ValidIdentifier,
+						Method:           testconstants.ValidMethod,
+					},
+				},
+				ContentStream: types.NewDereferencedResourceListStruct(
+					testconstants.ValidDid,
+					[]*resourceTypes.Metadata{
+						ResourceName12.Metadata,
+						ResourceName1.Metadata},
+				),
+				Metadata: &types.ResolutionDidDocMetadata{},
+			},
+			expectedError: nil,
+		},
+	),
+	Entry(
+		"Positive. Several resources with the same type",
+		ResourceMetadataTestCase{
+			didURL: fmt.Sprintf(
+				"/1.0/identifiers/%s?resourceType=%s&resourceMetadata=true",
+				testconstants.ValidDid,
+				ResourceType1.Metadata.ResourceType,
+			),
+			resolutionType: types.DIDJSONLD,
+			expectedDereferencingResult: &DereferencingResult{
+				DereferencingMetadata: &types.DereferencingMetadata{
+					DidProperties: types.DidProperties{
+						DidString:        testconstants.ExistentDid,
+						MethodSpecificId: testconstants.ValidIdentifier,
+						Method:           testconstants.ValidMethod,
+					},
+				},
+				ContentStream: types.NewDereferencedResourceListStruct(
+					testconstants.ValidDid,
+					[]*resourceTypes.Metadata{
+						ResourceType12.Metadata,
+						ResourceType1.Metadata,},
+				),
+				Metadata: &types.ResolutionDidDocMetadata{},
+			},
+			expectedError: nil,
+		},
+	),
 )