Validate TypeInstance input #629

mkuziemko · 2022-02-05T19:35:30Z

Description

Changes proposed in this pull request:

Validate TypeInstance input during TypeInstance creation, edition and uploading/updating TypeInstance by Argo Action.

TODO:

fix manifests - now some of TypeInstance are invalid with the Type JSON schema. (PR: Fixes after validation of TypeInstances hub-manifests#56)

Test Cases

Test Case 1

Create a sample file:

typeInstances:
  - alias: aws-s3
    attributes:
      - path: cap.attribute.cloud.provider.aws
        revision: 0.1.0
    typeRef:
      path: cap.type.database.object.aws.s3.bucket-config
      revision: 0.1.0
    value:
      host: https://s3.amazonaws.com

Build a binary:

make build-tool-cli

Verify that the validation errors occur:

./bin/capact-linux-amd64 typeinstances create -f test.yml 
Error: - Validation TypeInstances "TypeInstance with alias aws-s3":
    * (root): name is required
    * (root): Additional property host is not allowed

Change host to name and try one more time:

      name: https://s3.amazonaws.com

./bin/capact-linux-amd64 typeinstances create -f test.yml 
  ALIAS                ASSIGNED ID               
---------+---------------------------------------
  aws-s3   5605af48-c34f-4bdc-b2d8-53c679bdfa5a  
---------+---------------------------------------

The same steps could be repeated by this time with the edit action for TypeInstance with generated id 5605af48-c34f-4bdc-b2d8-53c679bdfa5a

Test Case 2

On this change try to install Matermost as described here.
Installation should not succeed on the upload TypeInstance step due to validation errors.

Related issue(s)

Validate TypeInstance input during TypeInstance creation #544

pkosiec

Disclaimer: I didn't run it, I just make a code review. Before merging this PR, please make sure that at least our Mattermost, Rocketchat and Concourse manifests run well.

pkosiec · 2022-02-07T12:31:08Z

cmd/argo-actions/main.go

+ LocalHubEndpoint string `envconfig:"default=http://capact-hub-local.capact-system/graphql"`
+ PublicHubEndpoint string `envconfig:"default=http://capact-hub-public.capact-system/graphql"`


As discussed previously, please make sure the Environmental variables are set properly during Engine Rendering both for download, update and create TypeInstances (see the pkg/sdk/renderer/argo/typeinstance_handler.go).

What about this comment? I don't see any render logic changed 🤔

cmd/argo-actions/main.go

cmd/cli/cmd/typeinstance/create.go

pkg/sdk/validation/typeinstance.go

pkosiec · 2022-02-08T08:04:04Z

BTW I forgot about two things:

please describe testing scenario in this PR (how to test the functionality that it works). This is helpful both for PR author and reviewer as well 🙂
consider an integration test case to test the uploader. To discuss whether it is really needed.

mkuziemko · 2022-02-10T13:31:36Z

test/e2e/action_test.go

@@ -1,3 +1,4 @@
+//go:build integration


In order to run integration tests, this change is needed: capactio/hub-manifests#56

pkg/argo-actions/upload_type_instances.go

pkosiec

Works well, but still some improvements in code are needed 🙂 And there's one quite important comment not addressed since last review.

cmd/argo-actions/main.go

pkosiec · 2022-02-14T13:04:36Z

cmd/argo-actions/main.go

+ LocalHubEndpoint string `envconfig:"default=http://capact-hub-local.capact-system/graphql"`
+ PublicHubEndpoint string `envconfig:"default=http://capact-hub-public.capact-system/graphql"`


What about this comment? I don't see any render logic changed 🤔

pkg/sdk/validation/typeinstance_test.go

pkg/argo-actions/upload_type_instances.go

pkg/sdk/validation/typeinstance.go

pkosiec · 2022-02-14T16:28:15Z

pkg/sdk/validation/typeinstance.go

+ if _, ok := ti.value.(map[string]interface{}); !ok {
+ return Result{}, errors.New("could not create map from TypeInstance Value")
+ }


Why do we need this if? The TypeInstance value not necessarily is object and json.Marshal marshalls virtually everything.

This statement should cover the case when the user tries to edit TypeInstance and delete the values from it. Then, it would not be converted to map(string)interface and validation would not pass.

pkosiec · 2022-02-14T16:31:02Z

pkg/sdk/validation/typeinstance.go

+ if ti.alias != nil {
+ msg = fmt.Sprintf("TypeInstance with alias %s", *ti.alias)
+ } else if ti.id != "" {
+ msg = fmt.Sprintf("TypeInstance with id %s", ti.id)
+ }


Theoretically, in this scope of the validation function, there could be a case that a given TypeInstance contains both Alias and ID, right? So please use StringBuilder to build proper message taking into account that 🙂

Right, theoretically it could have both. I added a separate method and now the output is as:

Validation TypeInstances "TypeInstance(ID: some-id,Alias: aws-creds)": * (root): name is required * (root): Additional property host is not allowed

pkg/sdk/validation/typeinstance.go

pkosiec

Works well 👍 Before merge, please apply suggestions, especially around (ti *TypeInstanceEssentialData) String() to have more elegant output for user. Thanks!

pkg/sdk/renderer/argo/renderer_test.go

pkg/sdk/validation/typeinstance.go

pkg/sdk/validation/typeinstance_test.go

pkg/sdk/validation/typeinstance.go

pkosiec · 2022-02-18T07:29:09Z

pkg/sdk/validation/typeinstance_test.go

+ Alias: ptr.String("aws-creds-2"),
+ },
+ },
+ expError: fmt.Errorf("%s", "- Validation TypeInstances \"TypeInstance(Alias: aws-creds)\":\n * (root): key is required\n- Validation TypeInstances \"TypeInstance(Alias: aws-creds-2)\":\n * (root): key is required"),


Can't we just do something like:

Suggested change

expError: fmt.Errorf("%s", "- Validation TypeInstances \"TypeInstance(Alias: aws-creds)\":\n * (root): key is required\n- Validation TypeInstances \"TypeInstance(Alias: aws-creds-2)\":\n * (root): key is required"),

expError: errors.New("- Validation TypeInstances \"TypeInstance(Alias: aws-creds)\":\n * (root): key is required\n- Validation TypeInstances \"TypeInstance(Alias: aws-creds-2)\":\n * (root): key is required"),

Please adjust that in all places in this file

pkosiec · 2022-02-18T07:30:00Z

pkg/sdk/validation/typeinstance.go

+ }
+ typeRef, ok := typeInstancesTypeRef[ti.ID]
+ if !ok {
+ return nil, errors.Wrapf(err, "while finding TypeInstance Type reference for id %q", ti.ID)


Suggested change

return nil, errors.Wrapf(err, "while finding TypeInstance Type reference for id %q", ti.ID)

return nil, errors.Wrapf(err, "while finding TypeInstance Type reference for ID %q", ti.ID)

pkosiec · 2022-02-18T07:31:01Z

pkg/sdk/validation/typeinstance_test.go

+ ID: ptr.String("5605af48-c34f-4bdc-b2d8-53c679bdfa5a"),
+ },
+ },
+ expError: fmt.Errorf("%s", "- Validation TypeInstances \"TypeInstance(ID: 5605af48-c34f-4bdc-b2d8-53c679bdfa5a)\":\n * replicas: Invalid type. Expected: string, given: integer"),


BTW it would be good to trace the quotation around:

"TypeInstance(ID: 5605af48-c34f-4bdc-b2d8-53c679bdfa5a)\"

And remove it - as it shouldn't be there. In this case the quotation should be only for ID and Alias values.

pkosiec

🚀

Mateusz Kuziemko added 2 commits February 3, 2022 13:20

Validate TypeInstance input during TypeInstance creation

ae8b3dc

Merge branch 'main' into fix_typeinstance

5ce9612

mkuziemko requested review from mszostok, pkosiec and tmitchell as code owners February 5, 2022 19:35

pkosiec self-assigned this Feb 7, 2022

pkosiec reviewed Feb 7, 2022

View reviewed changes

mkuziemko added WIP Work in progress area/cli Relates to CLI area/hub Relates to Hub area/hub-manifests Relates to Hub manifests labels Feb 10, 2022

mkuziemko force-pushed the fix_typeinstance branch from fb20db4 to 8c0b221 Compare February 10, 2022 09:57

Fixes after review

52c623f

mkuziemko force-pushed the fix_typeinstance branch from 8c0b221 to 52c623f Compare February 10, 2022 10:44

mkuziemko removed the WIP Work in progress label Feb 10, 2022

mkuziemko commented Feb 10, 2022

View reviewed changes

Fix e2e-tests

f7d2711

mkuziemko force-pushed the fix_typeinstance branch from beb1b0b to f7d2711 Compare February 10, 2022 13:57

pkosiec reviewed Feb 14, 2022

View reviewed changes

Correction after review

354571f

mkuziemko force-pushed the fix_typeinstance branch from 6d375ab to 354571f Compare February 15, 2022 19:29

pkosiec approved these changes Feb 16, 2022

View reviewed changes

Mateusz Kuziemko added 4 commits February 17, 2022 12:01

Small refactoring

b0e310b

Fix conflicts and merge master

3fa3219

Merge branch 'main' into fix_typeinstance

4221eca

Fix documentation error

1602c3e

pkosiec reviewed Feb 18, 2022

View reviewed changes

Improvements for IssueBuilder

652e1c0

pkosiec approved these changes Feb 18, 2022

View reviewed changes

mkuziemko merged commit 041d69e into capactio:main Feb 18, 2022

mkuziemko deleted the fix_typeinstance branch February 18, 2022 12:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Validate TypeInstance input #629

Validate TypeInstance input #629

mkuziemko commented Feb 5, 2022 •

edited

Loading

pkosiec left a comment •

edited

Loading

pkosiec Feb 7, 2022

pkosiec Feb 14, 2022

pkosiec commented Feb 8, 2022 •

edited

Loading

mkuziemko Feb 10, 2022

pkosiec left a comment

pkosiec Feb 14, 2022

pkosiec Feb 14, 2022

mkuziemko Feb 15, 2022

pkosiec Feb 14, 2022

mkuziemko Feb 15, 2022

pkosiec left a comment

pkosiec Feb 18, 2022

pkosiec Feb 18, 2022

pkosiec Feb 18, 2022

pkosiec left a comment

		LocalHubEndpoint string `envconfig:"default=http://capact-hub-local.capact-system/graphql"`
		PublicHubEndpoint string `envconfig:"default=http://capact-hub-public.capact-system/graphql"`

	expError: fmt.Errorf("%s", "- Validation TypeInstances \"TypeInstance(Alias: aws-creds)\":\n * (root): key is required\n- Validation TypeInstances \"TypeInstance(Alias: aws-creds-2)\":\n * (root): key is required"),
	expError: errors.New("- Validation TypeInstances \"TypeInstance(Alias: aws-creds)\":\n * (root): key is required\n- Validation TypeInstances \"TypeInstance(Alias: aws-creds-2)\":\n * (root): key is required"),

	return nil, errors.Wrapf(err, "while finding TypeInstance Type reference for id %q", ti.ID)
	return nil, errors.Wrapf(err, "while finding TypeInstance Type reference for ID %q", ti.ID)

Validate TypeInstance input #629

Validate TypeInstance input #629

Conversation

mkuziemko commented Feb 5, 2022 • edited Loading

Description

Test Cases

Related issue(s)

pkosiec left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pkosiec commented Feb 8, 2022 • edited Loading

Choose a reason for hiding this comment

pkosiec left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pkosiec left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pkosiec left a comment

Choose a reason for hiding this comment

mkuziemko commented Feb 5, 2022 •

edited

Loading

pkosiec left a comment •

edited

Loading

pkosiec commented Feb 8, 2022 •

edited

Loading