-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
340 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "constrained function - semvers" | ||
| subcategory: "" | ||
| description: |- | ||
| Checks whether semver is within constrain, returns a boolean | ||
| --- | ||
|
|
||
| # function: constrained | ||
|
|
||
| Checks whether semver is within constrain, returns a boolean | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| terraform { | ||
| required_providers { | ||
| semvers = { | ||
| source = "anapsix/semvers" | ||
| } | ||
| } | ||
| } | ||
| provider "semvers" {} | ||
| output "semvers_constrained_results" { | ||
| value = [ | ||
| { | ||
| expected = true | ||
| arguments = "0.1.1, >= 0.1" | ||
| result = provider::semvers::constrained("0.1.1", ">= 0.1") | ||
| }, | ||
| { | ||
| expected = false | ||
| arguments = "0.1, >= 0.1.1" | ||
| result = provider::semvers::constrained("0.1", ">= 0.1.1") | ||
| }, | ||
| { | ||
| expected = true | ||
| arguments = "0.1.2, ~> 0.1" | ||
| result = provider::semvers::constrained("0.1.2", "~> 0.1") | ||
| }, | ||
| { | ||
| expected = false | ||
| arguments = "0.2, ~> 0.1" | ||
| result = provider::semvers::constrained("0.2", "~> 0.1") | ||
| }, | ||
| { | ||
| expected = true | ||
| arguments = "0.2, 0.1.1 - 0.2.0" | ||
| result = provider::semvers::constrained("0.2", "0.1.1 - 0.2.0") | ||
| }, | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| ## Signature | ||
|
|
||
| <!-- signature generated by tfplugindocs --> | ||
| ```text | ||
| constrained(version string, constraint string) bool | ||
| ``` | ||
|
|
||
| ## Arguments | ||
|
|
||
| <!-- arguments generated by tfplugindocs --> | ||
| 1. `version` (String) Semver string version used as base for comparison | ||
| 1. `constraint` (String) Constraint string | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| terraform { | ||
| required_providers { | ||
| semvers = { | ||
| source = "anapsix/semvers" | ||
| } | ||
| } | ||
| } | ||
|
|
||
| provider "semvers" {} | ||
|
|
||
| output "semvers_constrained_results" { | ||
| value = [ | ||
| { | ||
| expected = true | ||
| arguments = "0.1.1, >= 0.1" | ||
| result = provider::semvers::constrained("0.1.1", ">= 0.1") | ||
| }, | ||
| { | ||
| expected = false | ||
| arguments = "0.1, >= 0.1.1" | ||
| result = provider::semvers::constrained("0.1", ">= 0.1.1") | ||
| }, | ||
| { | ||
| expected = true | ||
| arguments = "0.1.2, ~> 0.1" | ||
| result = provider::semvers::constrained("0.1.2", "~> 0.1") | ||
| }, | ||
| { | ||
| expected = false | ||
| arguments = "0.2, ~> 0.1" | ||
| result = provider::semvers::constrained("0.2", "~> 0.1") | ||
| }, | ||
| { | ||
| expected = true | ||
| arguments = "0.2, 0.1.1 - 0.2.0" | ||
| result = provider::semvers::constrained("0.2", "0.1.1 - 0.2.0") | ||
| }, | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| // Copyright (c) HashiCorp, Inc. | ||
| // Copyright (c) Anastas Dancha | ||
| // SPDX-License-Identifier: MPL-2.0 | ||
|
|
||
| package provider | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| shelper "github.com/anapsix/terraform-provider-semvers/internal/helpers" | ||
| "github.com/hashicorp/terraform-plugin-framework/function" | ||
| ) | ||
|
|
||
| var ( | ||
| _ function.Function = SemversConstrainedFunction{} | ||
| ) | ||
|
|
||
| func NewSemversConstrainedFunction() function.Function { | ||
| return SemversConstrainedFunction{} | ||
| } | ||
|
|
||
| type SemversConstrainedFunction struct{} | ||
|
|
||
| func (r SemversConstrainedFunction) Metadata(_ context.Context, req function.MetadataRequest, resp *function.MetadataResponse) { | ||
| resp.Name = "constrained" | ||
| } | ||
|
|
||
| func (r SemversConstrainedFunction) Definition(_ context.Context, _ function.DefinitionRequest, resp *function.DefinitionResponse) { | ||
| resp.Definition = function.Definition{ | ||
| Summary: "Checks whether semver is within constrain, returns a boolean", | ||
| MarkdownDescription: "Checks whether semver is within constrain, returns a boolean", | ||
| Parameters: []function.Parameter{ | ||
| function.StringParameter{ | ||
| AllowNullValue: false, | ||
| AllowUnknownValues: false, | ||
| Name: "version", | ||
| MarkdownDescription: "Semver string version used as base for comparison", | ||
| }, | ||
| function.StringParameter{ | ||
| AllowNullValue: false, | ||
| AllowUnknownValues: false, | ||
| Name: "constraint", | ||
| MarkdownDescription: "Constraint string", | ||
| }, | ||
| }, | ||
| Return: function.BoolReturn{}, | ||
| } | ||
| } | ||
|
|
||
| func (r SemversConstrainedFunction) Run(ctx context.Context, req function.RunRequest, resp *function.RunResponse) { | ||
| var version string | ||
| var constraint string | ||
| var compare_results bool | ||
|
|
||
| resp.Error = function.ConcatFuncErrors(req.Arguments.Get(ctx, &version, &constraint)) | ||
| if resp.Error != nil { | ||
| return | ||
| } | ||
|
|
||
| compare_results, err := shelper.Constrained(version, constraint) | ||
|
|
||
| if err != nil { | ||
| resp.Error = function.ConcatFuncErrors(resp.Error, function.NewFuncError("Error performing operation: "+err.Error())) | ||
| return | ||
| } | ||
|
|
||
| resp.Error = function.ConcatFuncErrors(resp.Error, resp.Result.Set(ctx, compare_results)) | ||
| } |
Oops, something went wrong.