helm/pkg/storage/driver/memory.go

/*
Copyright 2016 The Kubernetes Authors All rights reserved.

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 driver

import (
    "bytes"
    "fmt"
    "io"
    "strconv"
    "strings"
    "sync"

    rspb "k8s.io/helm/pkg/proto/hapi/release"
)

var _ Driver = (*Memory)(nil)

// MemoryDriverName is the string name of this driver.
const MemoryDriverName = "Memory"

// Memory is the in-memory storage driver implementation.
type Memory struct {
    sync.RWMutex
    cache map[string]records
}

// NewMemory initializes a new memory driver.
func NewMemory() *Memory {
    return &Memory{cache: map[string]records{}}
}

// Name returns the name of the driver.
func (mem *Memory) Name() string {
    return MemoryDriverName
}

// Get returns the release named by key or returns ErrReleaseNotFound.
func (mem *Memory) Get(key string) (*rspb.Release, error) {
    defer unlock(mem.rlock())

    switch elems := strings.Split(key, ".v"); len(elems) {
    case 2:
        name, ver := elems[0], elems[1]
        if _, err := strconv.Atoi(ver); err != nil {
            return nil, ErrInvalidKey
        }
        if recs, ok := mem.cache[name]; ok {
            if r := recs.Get(key); r != nil {
                return r.rls, nil
            }
        }
        return nil, ErrReleaseNotFound
    default:
        return nil, ErrInvalidKey
    }
}

// List returns the list of all releases such that filter(release) == true
func (mem *Memory) List(filter func(*rspb.Release) bool) ([]*rspb.Release, error) {
    defer unlock(mem.rlock())

    var ls []*rspb.Release
    for _, recs := range mem.cache {
        recs.Iter(func(_ int, rec *record) bool {
            if filter(rec.rls) {
                ls = append(ls, rec.rls)
            }
            return true
        })
    }
    return ls, nil
}

// Query returns the set of releases that match the provided set of labels
func (mem *Memory) Query(keyvals map[string]string) ([]*rspb.Release, error) {
    defer unlock(mem.rlock())

    var lbs labels

    lbs.init()
    lbs.fromMap(keyvals)

    var ls []*rspb.Release
    for _, recs := range mem.cache {
        recs.Iter(func(_ int, rec *record) bool {
            if rec.lbs.match(lbs) {
                ls = append(ls, rec.rls)
            }
            return true
        })
    }
    return ls, nil
}

// Create creates a new release or returns ErrReleaseExists.
func (mem *Memory) Create(key string, rls *rspb.Release) error {
    defer unlock(mem.wlock())

    if recs, ok := mem.cache[rls.Name]; ok {
        if err := recs.Add(newRecord(key, rls)); err != nil {
            return err
        }
        mem.cache[rls.Name] = recs
        return nil
    }
    mem.cache[rls.Name] = records{newRecord(key, rls)}
    return nil
}

// Update updates a release or returns ErrReleaseNotFound.
func (mem *Memory) Update(key string, rls *rspb.Release) error {
    defer unlock(mem.wlock())

    if rs, ok := mem.cache[rls.Name]; ok && rs.Exists(key) {
        rs.Replace(key, newRecord(key, rls))
        return nil
    }
    return ErrReleaseNotFound
}

// Delete deletes a release or returns ErrReleaseNotFound.
func (mem *Memory) Delete(key string) (*rspb.Release, error) {
    defer unlock(mem.wlock())

    switch elems := strings.Split(key, ".v"); len(elems) {
    case 2:
        name, ver := elems[0], elems[1]
        if _, err := strconv.Atoi(ver); err != nil {
            return nil, ErrInvalidKey
        }
        if recs, ok := mem.cache[name]; ok {
            if r := recs.Remove(key); r != nil {
                return r.rls, nil
            }
        }
        return nil, ErrReleaseNotFound
    default:
        return nil, ErrInvalidKey
    }
    return nil, ErrReleaseNotFound
}

func (mem *Memory) dump(w io.Writer) error {
    var b bytes.Buffer

    fmt.Fprintln(&b, "memory:")
    for key, recs := range mem.cache {
        fmt.Fprintf(&b, "\t# %q\n", key)

        recs.Iter(func(index int, r *record) bool {
            fmt.Fprintf(&b, "\t\t- [%d] v%d (status = %s)\n",
                index,
                r.rls.Version,
                r.rls.Info.Status.Code,
            )

            return true
        })
    }

    _, err := w.Write(b.Bytes())
    return err
}

// wlock locks mem for writing
func (mem *Memory) wlock() func() {
    mem.Lock()
    return func() { mem.Unlock() }
}

// rlock locks mem for reading
func (mem *Memory) rlock() func() {
    mem.RLock()
    return func() { mem.RUnlock() }
}

// unlock calls fn which reverses a mem.rlock or mem.wlock. e.g:
// ```defer unlock(mem.rlock())```, locks mem for reading at the
// call point of defer and unlocks upon exiting the block.
func unlock(fn func()) { fn() }