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
|
// Copyright (c) 2018-2020, Sylabs Inc. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the
// LICENSE.md file distributed with the URIs of this project regarding your
// rights to use or distribute this software.
package main
import (
"errors"
"fmt"
"github.com/spf13/cobra"
"github.com/sylabs/singularity/v4/pkg/cmdline"
pluginapi "github.com/sylabs/singularity/v4/pkg/plugin"
clicallback "github.com/sylabs/singularity/v4/pkg/plugin/callback/cli"
"github.com/sylabs/singularity/v4/pkg/sylog"
)
// Plugin is the only variable which a plugin MUST export.
// This symbol is accessed by the plugin framework to initialize the plugin.
var Plugin = pluginapi.Plugin{
Manifest: pluginapi.Manifest{
Name: "github.com/sylabs/singularity/cli-example-plugin",
Author: "Sylabs Team",
Version: "0.1.0",
Description: "This is a short example CLI plugin for Singularity",
},
Callbacks: []pluginapi.Callback{
(clicallback.Command)(callbackVersion),
(clicallback.Command)(callbackVerify),
(clicallback.Command)(callbackTestCmd),
},
}
func callbackVersion(manager *cmdline.CommandManager) {
versionCmd := manager.GetCmd("version")
if versionCmd == nil {
sylog.Warningf("Could not find version command")
return
}
var test string
manager.RegisterFlagForCmd(&cmdline.Flag{
Value: &test,
DefaultValue: "this is a test flag from plugin",
Name: "test",
Usage: "some text to print",
Hidden: false,
}, versionCmd)
f := versionCmd.PreRun
versionCmd.PreRun = func(c *cobra.Command, args []string) {
fmt.Printf("test: %v\n", test)
if f != nil {
f(c, args)
}
}
}
func callbackVerify(manager *cmdline.CommandManager) {
verifyCmd := manager.GetCmd("verify")
if verifyCmd == nil {
sylog.Warningf("Could not find verify command")
return
}
var abort bool
manager.RegisterFlagForCmd(&cmdline.Flag{
Value: &abort,
DefaultValue: false,
Name: "abort",
Usage: "should the verify command be aborted?",
}, verifyCmd)
f := verifyCmd.PreRunE
verifyCmd.PreRunE = func(c *cobra.Command, args []string) error {
if f != nil {
if err := f(c, args); err != nil {
return err
}
}
if abort {
return errors.New("aborting verify from the plugin")
}
return nil
}
}
func callbackTestCmd(manager *cmdline.CommandManager) {
manager.RegisterCmd(&cobra.Command{
DisableFlagsInUseLine: true,
Args: cobra.MinimumNArgs(1),
Use: "test-cmd [args ...]",
Short: "Test test test",
Long: "Long test long test long test",
Example: "singularity test-cmd my test",
Run: func(cmd *cobra.Command, args []string) {
fmt.Println("test-cmd is printing args:", args)
},
TraverseChildren: true,
})
}
|
