File: hooktypes.go

package info (click to toggle)
snapd 2.72-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 80,412 kB
  • sloc: sh: 16,506; ansic: 16,211; python: 11,213; makefile: 1,919; exp: 190; awk: 58; xml: 22
file content (107 lines) | stat: -rw-r--r-- 3,452 bytes parent folder | download | duplicates (2)
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * Copyright (C) 2016 Canonical Ltd
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package snap

import (
	"regexp"
)

var supportedHooks = []*HookType{
	NewHookType(regexp.MustCompile("^prepare-device$")),
	NewHookType(regexp.MustCompile("^install-device$")),
	NewHookType(regexp.MustCompile("^default-configure$")),
	NewHookType(regexp.MustCompile("^configure$")),
	NewHookType(regexp.MustCompile("^install$")),
	NewHookType(regexp.MustCompile("^pre-refresh$")),
	NewHookType(regexp.MustCompile("^post-refresh$")),
	NewHookType(regexp.MustCompile("^remove$")),
	NewHookType(regexp.MustCompile("^prepare-(?:plug|slot)-[-a-z0-9]+$")),
	NewHookType(regexp.MustCompile("^unprepare-(?:plug|slot)-[-a-z0-9]+$")),
	NewHookType(regexp.MustCompile("^connect-(?:plug|slot)-[-a-z0-9]+$")),
	NewHookType(regexp.MustCompile("^disconnect-(?:plug|slot)-[-a-z0-9]+$")),
	NewHookType(regexp.MustCompile("^check-health$")),
	NewHookType(regexp.MustCompile("^fde-setup$")),
	NewHookType(regexp.MustCompile("^gate-auto-refresh$")),
	NewHookType(regexp.MustCompile("^change-view-.+$")),
	NewHookType(regexp.MustCompile("^save-view-.+$")),
	NewHookType(regexp.MustCompile("^query-view-.+$")),
	NewHookType(regexp.MustCompile("^load-view-.+$")),
	NewHookType(regexp.MustCompile("^observe-view-.+$")),
}

var supportedComponentHooks = []*HookType{
	NewHookType(regexp.MustCompile("^install$")),
	NewHookType(regexp.MustCompile("^pre-refresh$")),
	NewHookType(regexp.MustCompile("^post-refresh$")),
	NewHookType(regexp.MustCompile("^remove$")),
}

// HookType represents a pattern of supported hook names.
type HookType struct {
	pattern *regexp.Regexp
}

// NewHookType returns a new HookType with the given pattern.
func NewHookType(pattern *regexp.Regexp) *HookType {
	return &HookType{
		pattern: pattern,
	}
}

// Match returns true if the given hook name matches this hook type.
func (hookType HookType) Match(hookName string) bool {
	return hookType.pattern.MatchString(hookName)
}

// IsHookSupported returns true if the given hook name matches one of the
// supported hooks.
func IsHookSupported(hookName string) bool {
	for _, hookType := range supportedHooks {
		if hookType.Match(hookName) {
			return true
		}
	}

	return false
}

// IsComponentHookSupported returns true if the given hook name matches one of
// the supported hooks.
func IsComponentHookSupported(hookName string) bool {
	for _, hookType := range supportedComponentHooks {
		if hookType.Match(hookName) {
			return true
		}
	}

	return false
}

func MockSupportedHookTypes(hookTypes []*HookType) (restore func()) {
	old := supportedHooks
	supportedHooks = hookTypes
	return func() { supportedHooks = old }
}

func MockAppendSupportedHookTypes(hookTypes []*HookType) (restore func()) {
	old := supportedHooks
	supportedHooks = append(supportedHooks, hookTypes...)
	return func() { supportedHooks = old }
}