-
Notifications
You must be signed in to change notification settings - Fork 137
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding validator for packages in
package.json. (#116)
* Adding validator for packages in `package.json`. * Renaming function argument to be more verbose. Co-authored-by: Igor Petkovic <igor@tenderly.co> * Using the more verbose argument. * Removing unused variable. * Changing the check to avoid unexpected behaviour. Co-authored-by: Igor Petkovic <igor@tenderly.co> * Limiting `@tenderly/actions` to `<0.1.0` for `V1` runtime. Co-authored-by: Igor Petkovic <igor@tenderly.co>
- Loading branch information
1 parent
9555f08
commit 0a8df71
Showing
5 changed files
with
220 additions
and
39 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,26 @@ | ||
| package packagejson | ||
|
|
||
| import "github.com/hashicorp/go-version" | ||
|
|
||
| type Constraints map[string]string | ||
|
|
||
| func (dc Constraints) findConstraints(dependencyName string) (version.Constraints, error) { | ||
| constraintString, ok := dc[dependencyName] | ||
| if !ok { | ||
| return nil, nil | ||
| } | ||
|
|
||
| constraints, err := version.NewConstraint(constraintString) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return constraints, nil | ||
| } | ||
|
|
||
| var runtimesToConstraints = map[string]*Constraints{ | ||
| "V1": { | ||
| "axios": "<1.0.0", | ||
| "@tenderly/actions": "<0.1.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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| package packagejson | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "encoding/json" | ||
| "fmt" | ||
| "os" | ||
| "os/exec" | ||
| "strings" | ||
|
|
||
| "github.com/hashicorp/go-version" | ||
| "github.com/pkg/errors" | ||
| "github.com/tenderly/tenderly-cli/userError" | ||
| ) | ||
|
|
||
| type Validator struct { | ||
| constraints *Constraints | ||
| } | ||
|
|
||
| func NewValidator(runtimeName string) *Validator { | ||
| constraints := runtimesToConstraints[strings.ToUpper(runtimeName)] | ||
| if constraints == nil { | ||
| return &Validator{ | ||
| constraints: &Constraints{}, | ||
| } | ||
| } | ||
|
|
||
| return &Validator{ | ||
| constraints: constraints, | ||
| } | ||
| } | ||
|
|
||
| type ValidationError struct { | ||
| Name string | ||
| PackageJsonVersion string | ||
| Constraint string | ||
| VersionToBeInstalled string | ||
| } | ||
|
|
||
| type ValidationResult struct { | ||
| Success bool | ||
| Errors []*ValidationError | ||
| } | ||
|
|
||
| func (dv *Validator) Validate(dependencies map[string]string) (*ValidationResult, error) { | ||
| var validationErrors []*ValidationError | ||
|
|
||
| for packageName, packageVersion := range dependencies { | ||
| constraint, err := dv.constraints.findConstraints(packageName) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| if constraint == nil { | ||
| continue | ||
| } | ||
|
|
||
| versionToBeInstalled, err := FindPackageVersion(packageName, packageVersion) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| parsedVersion, err := version.NewVersion(versionToBeInstalled) | ||
| if err != nil { | ||
| return nil, errors.New("error parsing version") | ||
| } | ||
|
|
||
| if !constraint.Check(parsedVersion) { | ||
| validationErrors = append(validationErrors, &ValidationError{ | ||
| Name: packageName, | ||
| PackageJsonVersion: packageVersion, | ||
| Constraint: constraint.String(), | ||
| VersionToBeInstalled: versionToBeInstalled, | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| return &ValidationResult{ | ||
| Success: len(validationErrors) == 0, | ||
| Errors: validationErrors, | ||
| }, nil | ||
| } | ||
|
|
||
| func FindPackageVersion(name string, version string) (string, error) { | ||
| lookup := name + "@" + version | ||
|
|
||
| cmd := exec.Command("npm", "view", lookup, "version", "--json") | ||
| var out bytes.Buffer | ||
| cmd.Stderr = os.Stderr | ||
| cmd.Stdout = &out | ||
|
|
||
| err := cmd.Start() | ||
| if err != nil { | ||
| return "", errors.New(fmt.Sprintf("Failed to run: npm view %s version --json", lookup)) | ||
| } | ||
|
|
||
| err = cmd.Wait() | ||
| if err != nil { | ||
| return "", errors.New(fmt.Sprintf("Failed to run: npm view %s version --json", lookup)) | ||
| } | ||
|
|
||
| ver, err := unmarshalVersion(out) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| return ver, nil | ||
| } | ||
|
|
||
| func unmarshalVersion(message bytes.Buffer) (string, error) { | ||
| var rawMessage json.RawMessage | ||
|
|
||
| err := json.Unmarshal(message.Bytes(), &rawMessage) | ||
| if err != nil { | ||
| return "", userError.NewUserError(err, "error unmarshalling response from npm") | ||
| } | ||
|
|
||
| switch rawMessage[0] { | ||
| case '"': | ||
| var v string | ||
| err = json.Unmarshal(rawMessage, &v) | ||
| if err != nil { | ||
| return "", userError.NewUserError(err, "error unmarshalling response from npm") | ||
| } | ||
|
|
||
| return v, nil | ||
| case '[': | ||
| var versions []string | ||
| err = json.Unmarshal(rawMessage, &versions) | ||
| if err != nil { | ||
| return "", userError.NewUserError(err, "error unmarshalling response from npm") | ||
| } | ||
|
|
||
| highestVersion := versions[len(versions)-1] | ||
| return highestVersion, nil | ||
| default: | ||
| err := errors.New(fmt.Sprintf("Unexpected response from npm: %s", rawMessage)) | ||
| return "", userError.NewUserError(err, "error unmarshalling response from npm") | ||
| } | ||
| } |
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