Add new metadata store.

Signed-off-by: Lantao Liu <lantaol@google.com>

pkg/store/sandbox/metadata.go

@@ -0,0 +1,79 @@
+/*
+Copyright 2017 The Kubernetes 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 sandbox
+
+import (
+	"encoding/json"
+	"fmt"
+
+	"k8s.io/kubernetes/pkg/kubelet/apis/cri/v1alpha1/runtime"
+)
+
+// NOTE(random-liu):
+// 1) Metadata is immutable after created.
+// 2) Metadata is checkpointed as containerd container label.
+
+// metadataVersion is current version of sandbox metadata.
+const metadataVersion = "v1" // nolint
+
+// versionedMetadata is the internal versioned sandbox metadata.
+// nolint
+type versionedMetadata struct {
+	// Version indicates the version of the versioned sandbox metadata.
+	Version string
+	Metadata
+}
+
+// Metadata is the unversioned sandbox metadata.
+type Metadata struct {
+	// ID is the sandbox id.
+	ID string
+	// Name is the sandbox name.
+	Name string
+	// Config is the CRI sandbox config.
+	Config *runtime.PodSandboxConfig
+	// CreatedAt is the created timestamp.
+	// TODO(random-liu): Use containerd container CreatedAt (containerd#933)
+	CreatedAt int64
+	// Pid is the process id of the sandbox.
+	Pid uint32
+	// NetNS is the network namespace used by the sandbox.
+	NetNS string
+}
+
+// Encode encodes Metadata into bytes in json format.
+func (c *Metadata) Encode() ([]byte, error) {
+	return json.Marshal(&versionedMetadata{
+		Version:  metadataVersion,
+		Metadata: *c,
+	})
+}
+
+// Decode decodes Metadata from bytes.
+func (c *Metadata) Decode(data []byte) error {
+	versioned := &versionedMetadata{}
+	if err := json.Unmarshal(data, versioned); err != nil {
+		return err
+	}
+	// Handle old version after upgrade.
+	switch versioned.Version {
+	case metadataVersion:
+		*c = versioned.Metadata
+		return nil
+	}
+	return fmt.Errorf("unsupported version")
+}

pkg/store/sandbox/metadata_test.go

@@ -0,0 +1,55 @@
+/*
+Copyright 2017 The Kubernetes 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 sandbox
+
+import (
+	"encoding/json"
+	"testing"
+	"time"
+
+	assertlib "github.com/stretchr/testify/assert"
+	"k8s.io/kubernetes/pkg/kubelet/apis/cri/v1alpha1/runtime"
+)
+
+func TestMetadataEncodeDecode(t *testing.T) {
+	meta := &Metadata{
+		ID:   "test-id",
+		Name: "test-name",
+		Config: &runtime.PodSandboxConfig{
+			Metadata: &runtime.PodSandboxMetadata{
+				Name:      "test-name",
+				Uid:       "test-uid",
+				Namespace: "test-namespace",
+				Attempt:   1,
+			},
+		},
+		CreatedAt: time.Now().UnixNano(),
+	}
+	assert := assertlib.New(t)
+	data, err := meta.Encode()
+	assert.NoError(err)
+	newMeta := &Metadata{}
+	assert.NoError(newMeta.Decode(data))
+	assert.Equal(meta, newMeta)
+
+	unsupported, err := json.Marshal(&versionedMetadata{
+		Version:  "random-test-version",
+		Metadata: *meta,
+	})
+	assert.NoError(err)
+	assert.Error(newMeta.Decode(unsupported))
+}

pkg/store/sandbox/sandbox.go

@@ -0,0 +1,88 @@
+/*
+Copyright 2017 The Kubernetes 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 sandbox
+
+import (
+	"sync"
+
+	"github.com/kubernetes-incubator/cri-containerd/pkg/store"
+)
+
+// Sandbox contains all resources associated with the sandbox. All methods to
+// mutate the internal state are thread safe.
+type Sandbox struct {
+	// Metadata is the metadata of the sandbox, it is immutable after created.
+	Metadata
+	// TODO(random-liu): Add containerd container client.
+	// TODO(random-liu): Add cni network namespace client.
+}
+
+// Store stores all sandboxes.
+type Store struct {
+	lock      sync.RWMutex
+	sandboxes map[string]Sandbox
+	// TODO(random-liu): Add trunc index.
+}
+
+// LoadStore loads sandboxes from runtime.
+// TODO(random-liu): Implement LoadStore.
+func LoadStore() *Store { return nil }
+
+// NewStore creates a sandbox store.
+func NewStore() *Store {
+	return &Store{sandboxes: make(map[string]Sandbox)}
+}
+
+// Add a sandbox into the store.
+func (s *Store) Add(sb Sandbox) error {
+	s.lock.Lock()
+	defer s.lock.Unlock()
+	if _, ok := s.sandboxes[sb.ID]; ok {
+		return store.ErrAlreadyExist
+	}
+	s.sandboxes[sb.ID] = sb
+	return nil
+}
+
+// Get returns the sandbox with specified id. Returns nil
+// if the sandbox doesn't exist.
+func (s *Store) Get(id string) (Sandbox, error) {
+	s.lock.RLock()
+	defer s.lock.RUnlock()
+	if sb, ok := s.sandboxes[id]; ok {
+		return sb, nil
+	}
+	return Sandbox{}, store.ErrNotExist
+}
+
+// List lists all sandboxes.
+func (s *Store) List() []Sandbox {
+	s.lock.RLock()
+	defer s.lock.RUnlock()
+	var sandboxes []Sandbox
+	for _, sb := range s.sandboxes {
+		sandboxes = append(sandboxes, sb)
+	}
+	return sandboxes
+}
+
+// Delete deletes the sandbox with specified id.
+func (s *Store) Delete(id string) {
+	s.lock.Lock()
+	defer s.lock.Unlock()
+	delete(s.sandboxes, id)
+}

pkg/store/sandbox/sandbox_test.go

@@ -0,0 +1,115 @@
+/*
+Copyright 2017 The Kubernetes 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 sandbox
+
+import (
+	"testing"
+	"time"
+
+	assertlib "github.com/stretchr/testify/assert"
+	"k8s.io/kubernetes/pkg/kubelet/apis/cri/v1alpha1/runtime"
+
+	"github.com/kubernetes-incubator/cri-containerd/pkg/store"
+)
+
+func TestSandboxStore(t *testing.T) {
+	ids := []string{"1", "2", "3"}
+	metadatas := map[string]Metadata{
+		"1": {
+			ID:   "1",
+			Name: "Sandbox-1",
+			Config: &runtime.PodSandboxConfig{
+				Metadata: &runtime.PodSandboxMetadata{
+					Name:      "TestPod-1",
+					Uid:       "TestUid-1",
+					Namespace: "TestNamespace-1",
+					Attempt:   1,
+				},
+			},
+			CreatedAt: time.Now().UnixNano(),
+			Pid:       1001,
+			NetNS:     "TestNetNS-1",
+		},
+		"2": {
+			ID:   "2",
+			Name: "Sandbox-2",
+			Config: &runtime.PodSandboxConfig{
+				Metadata: &runtime.PodSandboxMetadata{
+					Name:      "TestPod-2",
+					Uid:       "TestUid-2",
+					Namespace: "TestNamespace-2",
+					Attempt:   2,
+				},
+			},
+			CreatedAt: time.Now().UnixNano(),
+			Pid:       1002,
+			NetNS:     "TestNetNS-2",
+		},
+		"3": {
+			ID:   "3",
+			Name: "Sandbox-3",
+			Config: &runtime.PodSandboxConfig{
+				Metadata: &runtime.PodSandboxMetadata{
+					Name:      "TestPod-3",
+					Uid:       "TestUid-3",
+					Namespace: "TestNamespace-3",
+					Attempt:   3,
+				},
+			},
+			CreatedAt: time.Now().UnixNano(),
+			Pid:       1003,
+			NetNS:     "TestNetNS-3",
+		},
+	}
+	assert := assertlib.New(t)
+	sandboxes := map[string]Sandbox{}
+	for _, id := range ids {
+		sandboxes[id] = Sandbox{metadatas[id]}
+	}
+
+	s := NewStore()
+
+	t.Logf("should be able to add sandbox")
+	for _, sb := range sandboxes {
+		assert.NoError(s.Add(sb))
+	}
+
+	t.Logf("should be able to get sandbox")
+	for id, sb := range sandboxes {
+		got, err := s.Get(id)
+		assert.NoError(err)
+		assert.Equal(sb, got)
+	}
+
+	t.Logf("should be able to list sandboxes")
+	sbs := s.List()
+	assert.Len(sbs, 3)
+
+	testID := "2"
+	t.Logf("add should return already exists error for duplicated sandbox")
+	assert.Equal(store.ErrAlreadyExist, s.Add(sandboxes[testID]))
+
+	t.Logf("should be able to delete sandbox")
+	s.Delete(testID)
+	sbs = s.List()
+	assert.Len(sbs, 2)
+
+	t.Logf("get should return not exist error after deletion")
+	sb, err := s.Get(testID)
+	assert.Equal(Sandbox{}, sb)
+	assert.Equal(store.ErrNotExist, err)
+}