feat(spec): version field (#85)

Adds a `version` field to the `jsonnetfile.json`, so that `jb` can automatically recognize too old / too new schema versions, instead of panicking.

spec/v0/spec.go

@@ -0,0 +1,89 @@
+// Copyright 2018 jsonnet-bundler authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package spec
+
+import (
+	"encoding/json"
+	"sort"
+)
+
+// JsonnetFile is the structure of a `.json` file describing a set of jsonnet
+// dependencies. It is used for both, the jsonnetFile and the lockFile.
+type JsonnetFile struct {
+	Dependencies map[string]Dependency
+}
+
+// New returns a new JsonnetFile with the dependencies map initialized
+func New() JsonnetFile {
+	return JsonnetFile{
+		Dependencies: make(map[string]Dependency),
+	}
+}
+
+// jsonFile is the json representation of a JsonnetFile, which is different for
+// compatibility reasons.
+type jsonFile struct {
+	Dependencies []Dependency `json:"dependencies"`
+}
+
+// UnmarshalJSON unmarshals a `jsonFile`'s json into a JsonnetFile
+func (jf *JsonnetFile) UnmarshalJSON(data []byte) error {
+	var s jsonFile
+	if err := json.Unmarshal(data, &s); err != nil {
+		return err
+	}
+
+	jf.Dependencies = make(map[string]Dependency)
+	for _, d := range s.Dependencies {
+		jf.Dependencies[d.Name] = d
+	}
+	return nil
+}
+
+// MarshalJSON serializes a JsonnetFile into json of the format of a `jsonFile`
+func (jf JsonnetFile) MarshalJSON() ([]byte, error) {
+	var s jsonFile
+	for _, d := range jf.Dependencies {
+		s.Dependencies = append(s.Dependencies, d)
+	}
+
+	sort.SliceStable(s.Dependencies, func(i int, j int) bool {
+		return s.Dependencies[i].Name < s.Dependencies[j].Name
+	})
+
+	return json.Marshal(s)
+}
+
+type Dependency struct {
+	Name      string `json:"name"`
+	Source    Source `json:"source"`
+	Version   string `json:"version"`
+	Sum       string `json:"sum,omitempty"`
+	DepSource string `json:"-"`
+}
+
+type Source struct {
+	GitSource   *GitSource   `json:"git,omitempty"`
+	LocalSource *LocalSource `json:"local,omitempty"`
+}
+
+type GitSource struct {
+	Remote string `json:"remote"`
+	Subdir string `json:"subdir"`
+}
+
+type LocalSource struct {
+	Directory string `json:"directory"`
+}

spec/v0/spec_test.go

@@ -0,0 +1,109 @@
+// Copyright 2018 jsonnet-bundler authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package spec
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+const jsonJF = `{
+  "dependencies": [
+    {
+      "name": "grafana-builder",
+      "source": {
+        "git": {
+          "remote": "https://github.com/grafana/jsonnet-libs",
+          "subdir": "grafana-builder"
+        }
+      },
+      "version": "54865853ebc1f901964e25a2e7a0e4d2cb6b9648",
+      "sum": "ELsYwK+kGdzX1mee2Yy+/b2mdO4Y503BOCDkFzwmGbE="
+    },
+    {
+      "name": "prometheus-mixin",
+      "source": {
+        "git": {
+          "remote": "https://github.com/prometheus/prometheus",
+          "subdir": "documentation/prometheus-mixin"
+        }
+      },
+      "version": "7c039a6b3b4b2a9d7c613ac8bd3fc16e8ca79684",
+      "sum": "bVGOsq3hLOw2irNPAS91a5dZJqQlBUNWy3pVwM4+kIY="
+    }
+  ]
+}`
+
+func testData() JsonnetFile {
+	return JsonnetFile{
+		Dependencies: map[string]Dependency{
+			"grafana-builder": {
+				Name: "grafana-builder",
+				Source: Source{
+					GitSource: &GitSource{
+						Remote: "https://github.com/grafana/jsonnet-libs",
+						Subdir: "grafana-builder",
+					},
+				},
+				Version: "54865853ebc1f901964e25a2e7a0e4d2cb6b9648",
+				Sum:     "ELsYwK+kGdzX1mee2Yy+/b2mdO4Y503BOCDkFzwmGbE=",
+			},
+			"prometheus-mixin": {
+				Name: "prometheus-mixin",
+				Source: Source{
+					GitSource: &GitSource{
+						Remote: "https://github.com/prometheus/prometheus",
+						Subdir: "documentation/prometheus-mixin",
+					},
+				},
+				Version: "7c039a6b3b4b2a9d7c613ac8bd3fc16e8ca79684",
+				Sum:     "bVGOsq3hLOw2irNPAS91a5dZJqQlBUNWy3pVwM4+kIY=",
+			},
+		},
+	}
+}
+
+// TestUnmarshal checks that unmarshalling works
+func TestUnmarshal(t *testing.T) {
+	var dst JsonnetFile
+	err := json.Unmarshal([]byte(jsonJF), &dst)
+	require.NoError(t, err)
+	assert.Equal(t, testData(), dst)
+}
+
+// TestMarshal checks that marshalling works
+func TestMarshal(t *testing.T) {
+	data, err := json.Marshal(testData())
+	require.NoError(t, err)
+	assert.JSONEq(t, jsonJF, string(data))
+}
+
+// TestRemarshal checks that unmarshalling a previously marshalled object yields
+// the same object
+func TestRemarshal(t *testing.T) {
+	jf := testData()
+
+	data, err := json.Marshal(jf)
+	require.NoError(t, err)
+
+	var dst JsonnetFile
+	err = json.Unmarshal(data, &dst)
+	require.NoError(t, err)
+
+	assert.Equal(t, jf, dst)
+}