actions/kubeconform
9
0
Fork 0
mirror of https://github.com/yannh/kubeconform.git synced 2026-02-21 19:07:00 +00:00
Code Issues Projects Releases 1 Packages Wiki Activity Actions

add a few comments on exported vars

Browse source
This commit is contained in:
Yann Hamon 2020-06-06 18:42:44 +02:00
parent 7db0febbd1
commit d9a6468d09
4 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
pkg/output/json.go
View file

@ -36,6 +36,7 @@ func JSON(w io.Writer, withSummary bool, verbose bool) Output {
} }
} }
// JSON.Write will only write when JSON.Flush has been called
func (o *jsono) Write(filename, kind, version string, err error, skipped bool) error { func (o *jsono) Write(filename, kind, version string, err error, skipped bool) error {
msg, st := "", "" msg, st := "", ""
@ -65,6 +66,7 @@ func (o *jsono) Write(filename, kind, version string, err error, skipped bool) e
return nil return nil
} }
// Flush outputs the results as JSON
func (o *jsono) Flush() error { func (o *jsono) Flush() error {
var err error var err error
var res []byte var res []byte

2
pkg/registry/local.go
View file

@ -12,6 +12,7 @@ type LocalSchemas struct {
schemas map[string]string schemas map[string]string
} }
// NewLocalSchemas creates a new "registry", that will serve schemas from files, given a list of schema filenames
func NewLocalSchemas(schemaFiles []string) (*LocalSchemas, error) { func NewLocalSchemas(schemaFiles []string) (*LocalSchemas, error) {
schemas := &LocalSchemas{ schemas := &LocalSchemas{
schemas: map[string]string{}, schemas: map[string]string{},
@ -46,6 +47,7 @@ func NewLocalSchemas(schemaFiles []string) (*LocalSchemas, error) {
return schemas, nil return schemas, nil
} }
// DownloadSchema retrieves the schema from a file for the resource
func (r LocalSchemas) DownloadSchema(resourceKind, resourceAPIVersion, k8sVersion string) ([]byte, error) { func (r LocalSchemas) DownloadSchema(resourceKind, resourceAPIVersion, k8sVersion string) ([]byte, error) {
schemaFile, ok := r.schemas[resourceKind] schemaFile, ok := r.schemas[resourceKind]
if !ok { if !ok {

5
pkg/resource/signature.go
View file

@ -8,7 +8,8 @@ type Signature struct {
Kind, Version, Namespace string Kind, Version, Namespace string
} }
func SignatureFromBytes(s []byte) (Signature, error) { // SignatureFromBytes returns key identifying elements from a []byte representing the resource
func SignatureFromBytes(res []byte) (Signature, error) {
resource := struct { resource := struct {
APIVersion string `yaml:"apiVersion"` APIVersion string `yaml:"apiVersion"`
Kind string `yaml:"kind"` Kind string `yaml:"kind"`
@ -16,7 +17,7 @@ func SignatureFromBytes(s []byte) (Signature, error) {
Namespace string `yaml:"Namespace"` Namespace string `yaml:"Namespace"`
} `yaml:"Metadata"` } `yaml:"Metadata"`
}{} }{}
err := yaml.Unmarshal(s, &resource) err := yaml.Unmarshal(res, &resource)
return Signature{Kind: resource.Kind, Version: resource.APIVersion, Namespace: resource.Metadata.Namespace}, err return Signature{Kind: resource.Kind, Version: resource.APIVersion, Namespace: resource.Metadata.Namespace}, err
} }

2
pkg/validator/validator.go
View file

@ -32,7 +32,7 @@ func (f ValidFormat) IsFormat(input interface{}) bool {
// gojsonschema.FormatCheckers.Add("int-or-string", ValidFormat{}) // gojsonschema.FormatCheckers.Add("int-or-string", ValidFormat{})
// } // }
// Validates a single Kubernetes resource against a Json Schema // Validate validates a single Kubernetes resource against a Json Schema
func Validate(rawResource []byte, schema *gojsonschema.Schema) error { func Validate(rawResource []byte, schema *gojsonschema.Schema) error {
if schema == nil { if schema == nil {
return nil return nil