File: volume.go

package info (click to toggle)
golang-github-juju-names 4.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, trixie
  • size: 340 kB
  • sloc: makefile: 14
file content (92 lines) | stat: -rw-r--r-- 2,363 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
// Copyright 2014 Canonical Ltd.
// Licensed under the LGPLv3, see LICENCE file for details.

package names

import (
	"fmt"
	"regexp"
	"strings"
)

const VolumeTagKind = "volume"

// Volumes may be bound to a machine, meaning that the volume cannot
// exist without that machine. We encode this in the tag to allow
var validVolume = regexp.MustCompile("^((" + MachineSnippet + "|" + UnitSnippet + ")/)?" + NumberSnippet + "$")

type VolumeTag struct {
	id string
}

func (t VolumeTag) String() string { return t.Kind() + "-" + t.id }
func (t VolumeTag) Kind() string   { return VolumeTagKind }
func (t VolumeTag) Id() string     { return filesystemOrVolumeTagSuffixToId(t.id) }

// NewVolumeTag returns the tag for the volume with the given ID.
// It will panic if the given volume ID is not valid.
func NewVolumeTag(id string) VolumeTag {
	tag, ok := tagFromVolumeId(id)
	if !ok {
		panic(fmt.Sprintf("%q is not a valid volume ID", id))
	}
	return tag
}

// ParseVolumeTag parses a volume tag string.
func ParseVolumeTag(volumeTag string) (VolumeTag, error) {
	tag, err := ParseTag(volumeTag)
	if err != nil {
		return VolumeTag{}, err
	}
	dt, ok := tag.(VolumeTag)
	if !ok {
		return VolumeTag{}, invalidTagError(volumeTag, VolumeTagKind)
	}
	return dt, nil
}

// IsValidVolume returns whether id is a valid volume ID.
func IsValidVolume(id string) bool {
	return validVolume.MatchString(id)
}

// VolumeMachine returns the machine component of the volume
// tag, and a boolean indicating whether or not there is a
// machine component.
func VolumeMachine(tag VolumeTag) (MachineTag, bool) {
	id := tag.Id()
	pos := strings.LastIndex(id, "/")
	if pos == -1 {
		return MachineTag{}, false
	}
	id = id[:pos]
	if !IsValidMachine(id) {
		return MachineTag{}, false
	}
	return NewMachineTag(id), true
}

// VolumeUnit returns the unit component of the volume
// tag, and a boolean indicating whether or not there is a
// unit component.
func VolumeUnit(tag VolumeTag) (UnitTag, bool) {
	id := tag.Id()
	pos := strings.LastIndex(id, "/")
	if pos == -1 {
		return UnitTag{}, false
	}
	id = id[:pos]
	if !IsValidUnit(id) {
		return UnitTag{}, false
	}
	return NewUnitTag(id[:pos]), true
}

func tagFromVolumeId(id string) (VolumeTag, bool) {
	if !IsValidVolume(id) {
		return VolumeTag{}, false
	}
	id = strings.Replace(id, "/", "-", -1)
	return VolumeTag{id}, true
}