Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

cfn validate fails for wrong min/max constraint #414

Closed
surega21 opened this issue Apr 8, 2020 · 3 comments · Fixed by #675
Closed

cfn validate fails for wrong min/max constraint #414

surega21 opened this issue Apr 8, 2020 · 3 comments · Fixed by #675
Labels
bug Something isn't working schema processing

Comments

@surega21
Copy link

surega21 commented Apr 8, 2020 •
edited by PatMyron
Loading

For a numeric type, the range constraints allowed are : minimum, maximum, exclusiveMinimum, exclusiveMaximum.

A schema with string contraints - minLength, maxLength on a numeric type is simply ignored during validation.

ex wrong schema:

                "TimeoutMinutes": {
                    "description": "The maximum time in minutes that tests are permitted to run.",
                    "type": "integer",
                    "minLength": 60,
                    "maxLength": 1440
                }

The validation should fail here. The correct schema would be :

                "TimeoutMinutes": {
                    "description": "The maximum time in minutes that tests are permitted to run.",
                    "type": "integer",
                    "minimum": 60,
                    "maximum": 1440
                }
@wbingli wbingli added the bug Something isn't working label Apr 28, 2020
This was referenced Aug 6, 2020
Merged
Merged
Merged
@PatMyron
Copy link
Contributor

PatMyron commented Aug 6, 2020 •
edited
Loading

Will need to do a sweep of existing resource-providers once we can detect these

number with string minLength/maxLength constraints:
CloudformationSchemas $ grep -E -C 2 -i 'type.*(integer|number)' * | grep -E -i 'm[ia][nx]Length'
aws-cloudformation/aws-cloudformation-resource-providers-ssm#69 (comment)
aws-cloudformation/aws-cloudformation-resource-providers-opsworkscm#16 (comment)
aws-cloudformation/aws-cloudformation-resource-providers-iotwireless#4 (comment)
aws-cloudformation/aws-cloudformation-resource-providers-auditmanager#2 (comment)

string with numeric minimum/maximum constraints:
CloudformationSchemas $ grep -E -C 2 -i 'type.*string' * | grep -E -i '"m[ia][nx]imum"'
aws-cloudformation/aws-cloudformation-resource-providers-kinesisfirehose#16 (comment)
https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codepipeline/pull/8#discussion_r460315825
https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codepipeline/pull/9#discussion_r460316286
https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift/pull/6#discussion_r460316682
https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift/pull/7
aws-cloudformation/aws-cloudformation-resource-providers-applicationinsights#1
aws-cloudformation/aws-cloudformation-resource-providers-glue#1
aws-cloudformation/aws-cloudformation-resource-providers-sagemaker#2
https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2-ni/pull/4/#discussion_r553623394
aws-cloudformation/aws-cloudformation-resource-providers-iot#19 (comment)

object with string minLength/maxLength constraints:
CloudformationSchemas $ grep -E -C 2 -i 'type.*object' * | grep -E -i 'm[ia][nx]Length'
aws-cloudformation/aws-cloudformation-resource-providers-codeartifact#20 (comment)
aws-cloudformation/aws-cloudformation-resource-providers-codeartifact#22 (comment)

array with string minLength/maxLength constraints:
CloudformationSchemas $ grep -E -C 2 -i 'type.*array' * | grep -E -i '"m[ia][nx]Length"'
aws-cloudformation/aws-cloudformation-resource-providers-kendra#83 (comment)
https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-workspaces/pull/2#discussion_r566405923
aws-cloudformation/aws-cloudformation-resource-providers-iot#19 (comment)
aws-cloudformation/aws-cloudformation-resource-providers-sagemaker#2

This was referenced Aug 7, 2020
Merged
Closed
@rjlohan
Copy link
Contributor

rjlohan commented Aug 12, 2020

This might be worth pushing into the validation library we use: https://github.com/everit-org/json-schema

Also need to make sure our dependencies are up to date.

This was referenced Nov 3, 2020
Merged
Merged
Merged
avinash-karthik pushed a commit to aws-cloudformation/aws-cloudformation-resource-providers-opsworkscm that referenced this issue Nov 5, 2020
@PatMyron
AWS::OpsWorksCM::Server.BackupRetentionCount minimum integer constrai…
a9c53dd 
…nt instead of minLength (#33)

aws-cloudformation/cloudformation-cli#414
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworkscm-server.html#cfn-opsworkscm-server-backupretentioncount
#16 (comment)
https://json-schema.org/understanding-json-schema/reference/numeric.html#range
@PatMyron PatMyron mentioned this issue Dec 22, 2020
Closed
@PatMyron PatMyron changed the title cfn validate fails for wrong numeric constraint. cfn validate fails for wrong min/max constraint Jan 5, 2021
This was referenced Jan 7, 2021
Merged
Merged
Merged
Merged
This was referenced Jan 28, 2021
Merged
Merged
Merged
@PatMyron PatMyron linked a pull request Feb 3, 2021 that will close this issue
catch common resource schema issues in cfn validate #675
Merged
@PatMyron PatMyron mentioned this issue Mar 12, 2021
Merged
PatMyron added a commit that referenced this issue Apr 13, 2021
@PatMyron
catch common resource schema issues in cfn validate
3036779 
similar to #414
@PatMyron
Copy link
Contributor

PatMyron commented Apr 13, 2021 •
edited
Loading

More incorrect JSON schema keywords for specific types beyond min/max keywords like additionalProperties/additionalItems, catching in #729:

Incorrect JSON schema keyword(s) {'additionalProperties'} for type: array for property: EC2InboundPermissions
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: array for property: InstanceDefinitions
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: array for property: LogPaths
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: array for property: MetricGroups
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: array for property: MonitoringInputs
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: array for property: ServerProcesses
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: array for property: Tags
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: array for property: TaskProperties
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: array for property: VpcSubnets
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: integer for property: ConcurrentExecutions
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: integer for property: DesiredEC2Instances
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: integer for property: FromPort
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: integer for property: GameSessionActivationTimeoutSeconds
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: integer for property: MaxConcurrentGameSessionActivations
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: integer for property: MaxSize
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: integer for property: MinSize
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: integer for property: NewGameSessionsPerCreator
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: integer for property: PolicyPeriodInMinutes
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: integer for property: ToPort
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: number for property: EstimatedInstanceWarmup
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: number for property: MaxSize
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: number for property: MinSize
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: number for property: TargetValue
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: AutoScalingGroupArn
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: BalancingStrategy
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: BuildId
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: CertificateType
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: DeleteOption
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: Description
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: EC2InstanceType
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: FleetId
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: FleetType
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: GameServerGroupArn
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: GameServerGroupName
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: GameServerProtectionPolicy
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: InstanceRoleARN
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: InstanceType
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: IpRange
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: LaunchPath
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: LaunchTemplateId
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: LaunchTemplateName
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: Name
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: NewGameSessionProtectionPolicy
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: Parameters
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: PeerVpcAwsAccountId
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: PeerVpcId
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: Protocol
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: RoleArn
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: ScriptId
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: ServerLaunchParameters
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: ServerLaunchPath
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: Version
Incorrect JSON schema keyword(s) {'additionalProperties'} for type: string for property: WeightedCapacity
Incorrect JSON schema keyword(s) {'format'} for type: integer for property: BytesPerSecond
Incorrect JSON schema keyword(s) {'format'} for type: integer for property: BytesScannedCutoffPerQuery
Incorrect JSON schema keyword(s) {'format'} for type: integer for property: BytesScannedCutoffPerQuery
Incorrect JSON schema keyword(s) {'format'} for type: integer for property: Gt
Incorrect JSON schema keyword(s) {'format'} for type: integer for property: Gte
Incorrect JSON schema keyword(s) {'format'} for type: integer for property: Lt
Incorrect JSON schema keyword(s) {'format'} for type: integer for property: Lte
Incorrect JSON schema keyword(s) {'format'} for type: integer for property: Size
Incorrect JSON schema keyword(s) {'format'} for type: number for property: ProbabilityThresholdAttribute
Incorrect JSON schema keyword(s) {'format'} for type: number for property: ProbabilityThresholdAttribute

format seems intentionally used for other types?, so I guess I'll leave that out of the new validation

@PatMyron PatMyron mentioned this issue Apr 13, 2021
Merged
PatMyron added a commit that referenced this issue Apr 26, 2021
@PatMyron
catch common resource schema issues in cfn validate (#729)
a9ab27a 
expanding type_specific_keywords similar to #414
eduardomourar pushed a commit to eduardomourar/cloudformation-cli that referenced this issue Apr 30, 2021
@PatMyron @eduardomourar
catch common resource schema issues in cfn validate (aws-cloudformati…
f0c3a1a 
…on#729)

expanding type_specific_keywords similar to aws-cloudformation#414
@PatMyron PatMyron mentioned this issue Feb 15, 2022
Closed
kddejong pushed a commit to kddejong/cloudformation-cli that referenced this issue Oct 24, 2022
@PatMyron @kddejong
catch common resource schema issues in cfn validate (aws-cloudformati…
ebd7eb2 
…on#729)

expanding type_specific_keywords similar to aws-cloudformation#414
kddejong pushed a commit to kddejong/cloudformation-cli that referenced this issue Oct 24, 2022
@PatMyron @kddejong
catch common resource schema issues in cfn validate (aws-cloudformati…
5a18a25 
…on#729)

expanding type_specific_keywords similar to aws-cloudformation#414
awesomedevchris pushed a commit to awesomedevchris/awesome_app that referenced this issue Apr 10, 2023
@PatMyron
catch common resource schema issues in cfn validate (#729)
d63ea75 
expanding type_specific_keywords similar to aws-cloudformation/cloudformation-cli#414
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working schema processing
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

catch common resource schema issues in cfn validate aws-cloudformation/cloudformation-cli
4 participants
@wbingli @rjlohan @PatMyron @surega21