From 225b2c44761bfd203b67d388080940e08f53e099 Mon Sep 17 00:00:00 2001 From: Sven Luca Hafemann <114884726+SLH335@users.noreply.github.com> Date: Fri, 10 Jan 2025 13:05:13 +0000 Subject: [PATCH 1/4] feat: form for interactive config file creation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: René Kuhn --- createConfig.go | 69 +++++++++++++++++++++++++++++++++++++++++++++++++ go.mod | 31 +++++++++++++++++++--- go.sum | 69 ++++++++++++++++++++++++++++++++++++++++++------- main.go | 23 +++++++++++++---- 4 files changed, 173 insertions(+), 19 deletions(-) create mode 100644 createConfig.go diff --git a/createConfig.go b/createConfig.go new file mode 100644 index 0000000..7e93ab2 --- /dev/null +++ b/createConfig.go @@ -0,0 +1,69 @@ +package main + +import ( + "encoding/json" + "fmt" + "os" + + "github.com/charmbracelet/huh" +) + +var defaultMountDir string = "/mnt/cinder" + +func createConfiguration(config *tConfig, path string) (runProgram bool, err error) { + credentialInstructions := + `To get an Application Credential ID you must create new Application Credentials +via the web console (Horizon). +Navigate to "Identity > Application Credentials > Create Application Credential" +Enter a descriptive name and optionally a description and expiration date. +Press 'Create Application Credential', copy the displayed ID and paste it here. + +Do not close the window yet.` + + mountDirInstructions := fmt.Sprintf(`Directory used for mounting cinder volumes +Leave blank for default: '%s'`, defaultMountDir) + + err = huh.NewForm( + huh.NewGroup( + huh.NewInput().Title("Open Stack endpoint URL").Value(&config.IdentityEndpoint), + huh.NewInput().Title("Open Stack Region Name").Value(&config.Region), + ), + huh.NewGroup( + huh.NewInput().Title("Application Credential ID").Value(&config.ApplicationCredentialID).Description(credentialInstructions), + huh.NewInput().Title("Application Credential Secret").Value(&config.ApplicationCredentialSecret).Description("Copy the displayed Secret and paste it here").EchoMode(huh.EchoModePassword), + ), + huh.NewGroup( + huh.NewInput().Title("Mount Dir").Value(&config.MountDir).Description(mountDirInstructions), + ), + huh.NewGroup( + huh.NewConfirm().Title("Run plugin after creating config?").Value(&runProgram), + ), + ).Run() + if err != nil { + return false, err + } + + if config.MountDir == "" { + config.MountDir = defaultMountDir + } + + err = writeConfiguration(*config, path) + if err != nil { + return false, err + } + + return runProgram, nil +} + +func writeConfiguration(config tConfig, path string) error { + configText, err := json.MarshalIndent(config, "", " ") + if err != nil { + return err + } + + err = os.WriteFile(path, configText, 0664) + if err != nil { + return err + } + return nil +} diff --git a/go.mod b/go.mod index ca2251a..bc78406 100644 --- a/go.mod +++ b/go.mod @@ -3,6 +3,7 @@ module github.com/jgraichen/docker-plugin-cinder go 1.23 require ( + github.com/charmbracelet/huh v0.6.0 github.com/coreos/go-systemd/v22 v22.5.0 github.com/docker/go-plugins-helpers v0.0.0-20240701071450-45e2431495c8 github.com/gophercloud/gophercloud/v2 v2.2.0 @@ -12,10 +13,32 @@ require ( require ( github.com/Microsoft/go-winio v0.6.0 // indirect + github.com/atotto/clipboard v0.1.4 // indirect + github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect + github.com/catppuccin/go v0.2.0 // indirect + github.com/charmbracelet/bubbles v0.20.0 // indirect + github.com/charmbracelet/bubbletea v1.1.0 // indirect + github.com/charmbracelet/lipgloss v0.13.0 // indirect + github.com/charmbracelet/x/ansi v0.2.3 // indirect + github.com/charmbracelet/x/exp/strings v0.0.0-20240722160745-212f7b056ed0 // indirect + github.com/charmbracelet/x/term v0.2.0 // indirect github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf // indirect github.com/docker/go-connections v0.4.0 // indirect - golang.org/x/mod v0.8.0 // indirect - golang.org/x/net v0.23.0 // indirect - golang.org/x/sys v0.22.0 // indirect - golang.org/x/tools v0.6.0 // indirect + github.com/dustin/go-humanize v1.0.1 // indirect + github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f // indirect + github.com/lucasb-eyer/go-colorful v1.2.0 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/mattn/go-localereader v0.0.1 // indirect + github.com/mattn/go-runewidth v0.0.16 // indirect + github.com/mitchellh/hashstructure/v2 v2.0.2 // indirect + github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 // indirect + github.com/muesli/cancelreader v0.2.2 // indirect + github.com/muesli/termenv v0.15.3-0.20240618155329-98d742f6907a // indirect + github.com/rivo/uniseg v0.4.7 // indirect + golang.org/x/mod v0.17.0 // indirect + golang.org/x/net v0.25.0 // indirect + golang.org/x/sync v0.8.0 // indirect + golang.org/x/sys v0.25.0 // indirect + golang.org/x/text v0.18.0 // indirect + golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d // indirect ) diff --git a/go.sum b/go.sum index f803f12..1964d1b 100644 --- a/go.sum +++ b/go.sum @@ -1,5 +1,27 @@ +github.com/MakeNowJust/heredoc v1.0.0 h1:cXCdzVdstXyiTqTvfqk9SDHpKNjxuom+DOlyEeQ4pzQ= +github.com/MakeNowJust/heredoc v1.0.0/go.mod h1:mG5amYoWBHf8vpLOuehzbGGw0EHxpZZ6lCpQ4fNJ8LE= github.com/Microsoft/go-winio v0.6.0 h1:slsWYD/zyx7lCXoZVlvQrj0hPTM1HI4+v1sIda2yDvg= github.com/Microsoft/go-winio v0.6.0/go.mod h1:cTAf44im0RAYeL23bpB+fzCyDH2MJiz2BO69KH/soAE= +github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z4= +github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI= +github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k= +github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8= +github.com/catppuccin/go v0.2.0 h1:ktBeIrIP42b/8FGiScP9sgrWOss3lw0Z5SktRoithGA= +github.com/catppuccin/go v0.2.0/go.mod h1:8IHJuMGaUUjQM82qBrGNBv7LFq6JI3NnQCF6MOlZjpc= +github.com/charmbracelet/bubbles v0.20.0 h1:jSZu6qD8cRQ6k9OMfR1WlM+ruM8fkPWkHvQWD9LIutE= +github.com/charmbracelet/bubbles v0.20.0/go.mod h1:39slydyswPy+uVOHZ5x/GjwVAFkCsV8IIVy+4MhzwwU= +github.com/charmbracelet/bubbletea v1.1.0 h1:FjAl9eAL3HBCHenhz/ZPjkKdScmaS5SK69JAK2YJK9c= +github.com/charmbracelet/bubbletea v1.1.0/go.mod h1:9Ogk0HrdbHolIKHdjfFpyXJmiCzGwy+FesYkZr7hYU4= +github.com/charmbracelet/huh v0.6.0 h1:mZM8VvZGuE0hoDXq6XLxRtgfWyTI3b2jZNKh0xWmax8= +github.com/charmbracelet/huh v0.6.0/go.mod h1:GGNKeWCeNzKpEOh/OJD8WBwTQjV3prFAtQPpLv+AVwU= +github.com/charmbracelet/lipgloss v0.13.0 h1:4X3PPeoWEDCMvzDvGmTajSyYPcZM4+y8sCA/SsA3cjw= +github.com/charmbracelet/lipgloss v0.13.0/go.mod h1:nw4zy0SBX/F/eAO1cWdcvy6qnkDUxr8Lw7dvFrAIbbY= +github.com/charmbracelet/x/ansi v0.2.3 h1:VfFN0NUpcjBRd4DnKfRaIRo53KRgey/nhOoEqosGDEY= +github.com/charmbracelet/x/ansi v0.2.3/go.mod h1:dk73KoMTT5AX5BsX0KrqhsTqAnhZZoCBjs7dGWp4Ktw= +github.com/charmbracelet/x/exp/strings v0.0.0-20240722160745-212f7b056ed0 h1:qko3AQ4gK1MTS/de7F5hPGx6/k1u0w4TeYmBFwzYVP4= +github.com/charmbracelet/x/exp/strings v0.0.0-20240722160745-212f7b056ed0/go.mod h1:pBhA0ybfXv6hDjQUZ7hk1lVxBiUbupdw5R31yPUViVQ= +github.com/charmbracelet/x/term v0.2.0 h1:cNB9Ot9q8I711MyZ7myUR5HFWL/lc3OpU8jZ4hwm0x0= +github.com/charmbracelet/x/term v0.2.0/go.mod h1:GVxgxAbjUrmpvIINHIQnJJKpMlHiZ4cktEQCN6GWyF0= github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf h1:iW4rZ826su+pqaw19uhpSCzhj44qo35pNgKFGqzDKkU= github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4= github.com/coreos/go-systemd/v22 v22.5.0 h1:RrqgGjYQKalulkV8NGVIfkXQf6YYmOyiJKk8iXXhfZs= @@ -11,11 +33,34 @@ github.com/docker/go-connections v0.4.0 h1:El9xVISelRB7BuFusrZozjnkIM5YnzCViNKoh github.com/docker/go-connections v0.4.0/go.mod h1:Gbd7IOopHjR8Iph03tsViu4nIes5XhDvyHbTtUxmeec= github.com/docker/go-plugins-helpers v0.0.0-20240701071450-45e2431495c8 h1:IMfrF5LCzP2Vhw7j4IIH3HxPsCLuZYjDqFAM/C88ulg= github.com/docker/go-plugins-helpers v0.0.0-20240701071450-45e2431495c8/go.mod h1:LFyLie6XcDbyKGeVK6bHe+9aJTYCxWLBg5IrJZOaXKA= +github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY= +github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto= +github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f h1:Y/CXytFA4m6baUTXGLOoWe4PQhGxaX0KpnayAqC48p4= +github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f/go.mod h1:vw97MGsxSvLiUE2X8qFplwetxpGLQrlU1Q9AUEIzCaM= github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= github.com/gophercloud/gophercloud/v2 v2.2.0 h1:STqqnSXuhcg1OPBOZ14z6JDm8fKIN13H2bJg6bBuHp8= github.com/gophercloud/gophercloud/v2 v2.2.0/go.mod h1:f2hMRC7Kakbv5vM7wSGHrIPZh6JZR60GVHryJlF/K44= +github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY= +github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/mattn/go-localereader v0.0.1 h1:ygSAOl7ZXTx4RdPYinUpg6W99U8jWvWi9Ye2JC/oIi4= +github.com/mattn/go-localereader v0.0.1/go.mod h1:8fBrzywKY7BI3czFoHkuzRoWE9C+EiG4R1k4Cjx5p88= +github.com/mattn/go-runewidth v0.0.16 h1:E5ScNMtiwvlvB5paMFdw9p4kSQzbXFikJ5SQO6TULQc= +github.com/mattn/go-runewidth v0.0.16/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= +github.com/mitchellh/hashstructure/v2 v2.0.2 h1:vGKWl0YJqUNxE8d+h8f6NJLcCJrgbhC4NcD46KavDd4= +github.com/mitchellh/hashstructure/v2 v2.0.2/go.mod h1:MG3aRVU/N29oo/V/IhBX8GR/zz4kQkprJgF2EVszyDE= +github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 h1:ZK8zHtRHOkbHy6Mmr5D264iyp3TiX5OmNcI5cIARiQI= +github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6/go.mod h1:CJlz5H+gyd6CUWT45Oy4q24RdLyn7Md9Vj2/ldJBSIo= +github.com/muesli/cancelreader v0.2.2 h1:3I4Kt4BQjOR54NavqnDogx/MIoWBFa0StPA8ELUXHmA= +github.com/muesli/cancelreader v0.2.2/go.mod h1:3XuTXfFS2VjM+HTLZY9Ak0l6eUKfijIfMUZ4EgX0QYo= +github.com/muesli/termenv v0.15.3-0.20240618155329-98d742f6907a h1:2MaM6YC3mGu54x+RKAA6JiFFHlHDY1UbkxqppT7wYOg= +github.com/muesli/termenv v0.15.3-0.20240618155329-98d742f6907a/go.mod h1:hxSnBBYLK21Vtq/PHd0S2FYCxBXzBua8ov5s1RobyRQ= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= github.com/satori/go.uuid v1.2.0 h1:0uYX9dsZ2yD7q2RtLRtPSdGDWzjeM3TbMJP9utgA0ww= github.com/satori/go.uuid v1.2.0/go.mod h1:dA0hQrYB0VpLJoorglMZABFdXlWrHn1NEOzdhQKdks0= github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ= @@ -23,17 +68,21 @@ github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVs github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -golang.org/x/mod v0.8.0 h1:LUYupSeNrTNCGzR/hVBk2NHZO4hXcVaW1k4Qx7rjPx8= -golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= -golang.org/x/net v0.23.0 h1:7EYJ93RZ9vYSZAIb2x3lnuvqO5zneoD6IvWjuhfxjTs= -golang.org/x/net v0.23.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg= -golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o= -golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/mod v0.17.0 h1:zY54UmvipHiNd+pm+m0x9KhZ9hl1/7QNMyxXbc6ICqA= +golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= +golang.org/x/net v0.25.0 h1:d/OCCoBEUq33pjydKrGQhw7IlUPI2Oylr+8qLx49kac= +golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM= +golang.org/x/sync v0.8.0 h1:3NFvSEYkUoMifnESzZl15y791HH1qU2xm6eCJU5ZPXQ= +golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI= -golang.org/x/sys v0.22.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= -golang.org/x/tools v0.6.0 h1:BOw41kyTf3PuCW1pVQf8+Cyg8pMlkYB1oo9iJ6D/lKM= -golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.25.0 h1:r+8e+loiHxRqhXVl6ML1nO3l1+oFoWbnlu2Ehimmi34= +golang.org/x/sys v0.25.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/text v0.18.0 h1:XvMDiNzPAl0jr17s6W9lcaIhGUfUORdGCNsuLmPG224= +golang.org/x/text v0.18.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY= +golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d h1:vU5i/LfpvrRCpgM/VPfJLg5KjxD3E+hfT1SH+d9zLwg= +golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= diff --git a/main.go b/main.go index 265fcb6..6968637 100644 --- a/main.go +++ b/main.go @@ -17,9 +17,9 @@ import ( ) type tConfig struct { - Debug bool - Quiet bool - Prefix string `json:"prefix,omitempty"` + Debug bool `json:"-"` + Quiet bool `json:"-"` + Prefix string `json:"-"` IdentityEndpoint string `json:"endpoint,omitempty"` Username string `json:"username,omitempty"` Password string `json:"password,omitempty"` @@ -46,15 +46,28 @@ func init() { func main() { var config tConfig var configFile string + var createConfig bool flag.BoolVar(&config.Debug, "debug", false, "Enable debug logging") flag.BoolVar(&config.Quiet, "quiet", false, "Only report errors") flag.StringVar(&configFile, "config", "", "") flag.StringVar(&config.Prefix, "prefix", "docker-volume", "") flag.StringVar(&config.MountDir, "mountDir", "", "") + flag.BoolVar(&createConfig, "create_config", false, "Create config interactively") flag.Parse() - if len(configFile) == 0 { - configFile = "cinder.json" + if configFile == "" { + configFile = "./cinder.json" + } + + if createConfig { + runProgram, err := createConfiguration(&config, configFile) + if err != nil { + log.Fatal("Failed to write configuration file") + } + log.Info("Configuration file written successfully") + if !runProgram { + os.Exit(0) + } } log.SetFormatter(&log.TextFormatter{DisableTimestamp: true}) From 09c7a8427a0793181ef637787958661902e31bc3 Mon Sep 17 00:00:00 2001 From: Sven Luca Hafemann <114884726+SLH335@users.noreply.github.com> Date: Thu, 23 Jan 2025 16:41:07 +0000 Subject: [PATCH 2/4] feat: separate config struct for config creation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: René Kuhn --- createConfig.go | 51 +++++++++++++++++++++++++++++++++---------------- main.go | 22 ++++++++++----------- 2 files changed, 45 insertions(+), 28 deletions(-) diff --git a/createConfig.go b/createConfig.go index 7e93ab2..e5490dc 100644 --- a/createConfig.go +++ b/createConfig.go @@ -2,15 +2,23 @@ package main import ( "encoding/json" + "errors" "fmt" "os" + "path" "github.com/charmbracelet/huh" ) -var defaultMountDir string = "/mnt/cinder" +type setupConfig struct { + IdentityEndpoint string `json:"endpoint"` + ApplicationCredentialID string `json:"applicationCredentialId"` + ApplicationCredentialSecret string `json:"applicationCredentialSecret"` + Region string `json:"region"` + MountDir string `json:"mountDir"` +} -func createConfiguration(config *tConfig, path string) (runProgram bool, err error) { +func createConfiguration(configPath string) (config setupConfig, err error) { credentialInstructions := `To get an Application Credential ID you must create new Application Credentials via the web console (Horizon). @@ -20,8 +28,26 @@ Press 'Create Application Credential', copy the displayed ID and paste it here. Do not close the window yet.` - mountDirInstructions := fmt.Sprintf(`Directory used for mounting cinder volumes -Leave blank for default: '%s'`, defaultMountDir) + mountDirInstructions := `Directory used for mounting cinder volumes +Leave blank for default` + + var overwriteFile bool = true + + stat, err := os.Stat(configPath) + if err == nil { + if stat.IsDir() { + return setupConfig{}, fmt.Errorf("The configuration file path already is a directory. Delete it or choose a different path to continue.") + } else { + err = huh.NewForm( + huh.NewGroup( + huh.NewConfirm().Title("The config file already exists. Overwrite it?").Description(fmt.Sprintf("Path: '%s'", configPath)).Value(&overwriteFile), + ), + ).Run() + } + } + if errors.Is(err, os.ErrNotExist) { + err = os.MkdirAll(path.Dir(configPath), 0775) + } err = huh.NewForm( huh.NewGroup( @@ -35,27 +61,20 @@ Leave blank for default: '%s'`, defaultMountDir) huh.NewGroup( huh.NewInput().Title("Mount Dir").Value(&config.MountDir).Description(mountDirInstructions), ), - huh.NewGroup( - huh.NewConfirm().Title("Run plugin after creating config?").Value(&runProgram), - ), ).Run() if err != nil { - return false, err - } - - if config.MountDir == "" { - config.MountDir = defaultMountDir + return setupConfig{}, err } - err = writeConfiguration(*config, path) + err = writeConfigurationFile(config, configPath) if err != nil { - return false, err + return setupConfig{}, err } - return runProgram, nil + return config, nil } -func writeConfiguration(config tConfig, path string) error { +func writeConfigurationFile(config setupConfig, path string) error { configText, err := json.MarshalIndent(config, "", " ") if err != nil { return err diff --git a/main.go b/main.go index 6968637..cbb93fe 100644 --- a/main.go +++ b/main.go @@ -17,9 +17,9 @@ import ( ) type tConfig struct { - Debug bool `json:"-"` - Quiet bool `json:"-"` - Prefix string `json:"-"` + Debug bool `json:"debug,omitempty"` + Quiet bool `json:"quiet,omitempty"` + Prefix string `json:"prefix,omitempty"` IdentityEndpoint string `json:"endpoint,omitempty"` Username string `json:"username,omitempty"` Password string `json:"password,omitempty"` @@ -49,10 +49,10 @@ func main() { var createConfig bool flag.BoolVar(&config.Debug, "debug", false, "Enable debug logging") flag.BoolVar(&config.Quiet, "quiet", false, "Only report errors") - flag.StringVar(&configFile, "config", "", "") + flag.StringVar(&configFile, "config", "", "Path to config file") flag.StringVar(&config.Prefix, "prefix", "docker-volume", "") flag.StringVar(&config.MountDir, "mountDir", "", "") - flag.BoolVar(&createConfig, "create_config", false, "Create config interactively") + flag.BoolVar(&createConfig, "createConfig", false, "Create config file interactively") flag.Parse() if configFile == "" { @@ -60,14 +60,12 @@ func main() { } if createConfig { - runProgram, err := createConfiguration(&config, configFile) + _, err := createConfiguration(configFile) if err != nil { - log.Fatal("Failed to write configuration file") + log.Fatalf("Failed to write configuration file: %s", err) } log.Info("Configuration file written successfully") - if !runProgram { - os.Exit(0) - } + os.Exit(0) } log.SetFormatter(&log.TextFormatter{DisableTimestamp: true}) @@ -83,7 +81,7 @@ func main() { log.Fatal(err.Error()) } - if len(config.MountDir) == 0 { + if config.MountDir == "" { log.Fatal("No mountDir configured. Abort.") } @@ -97,7 +95,7 @@ func main() { log.Debug("Debug logging enabled") - if len(config.IdentityEndpoint) == 0 { + if config.IdentityEndpoint == "" { log.Fatal("Identity endpoint missing") } From 15364f7a4a96235bc8d5ef42db3099bc1c15c856 Mon Sep 17 00:00:00 2001 From: Sven Luca Hafemann <114884726+SLH335@users.noreply.github.com> Date: Fri, 24 Jan 2025 14:47:26 +0000 Subject: [PATCH 3/4] fix: abort config creation when not overwriting MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: René Kuhn --- createConfig.go | 38 ++++++++++++++++++++------------------ main.go | 9 ++++++--- 2 files changed, 26 insertions(+), 21 deletions(-) diff --git a/createConfig.go b/createConfig.go index e5490dc..e3ea492 100644 --- a/createConfig.go +++ b/createConfig.go @@ -11,14 +11,16 @@ import ( ) type setupConfig struct { - IdentityEndpoint string `json:"endpoint"` - ApplicationCredentialID string `json:"applicationCredentialId"` - ApplicationCredentialSecret string `json:"applicationCredentialSecret"` - Region string `json:"region"` - MountDir string `json:"mountDir"` + IdentityEndpoint string `json:"endpoint,omitempty"` + ApplicationCredentialID string `json:"applicationCredentialId,omitempty"` + ApplicationCredentialSecret string `json:"applicationCredentialSecret,omitempty"` + Region string `json:"region,omitempty"` + MountDir string `json:"mountDir,omitempty"` } -func createConfiguration(configPath string) (config setupConfig, err error) { +func createConfiguration(configPath string) error { + var config setupConfig + credentialInstructions := `To get an Application Credential ID you must create new Application Credentials via the web console (Horizon). @@ -31,21 +33,26 @@ Do not close the window yet.` mountDirInstructions := `Directory used for mounting cinder volumes Leave blank for default` - var overwriteFile bool = true - stat, err := os.Stat(configPath) if err == nil { if stat.IsDir() { - return setupConfig{}, fmt.Errorf("The configuration file path already is a directory. Delete it or choose a different path to continue.") + return fmt.Errorf("The configuration file path already is a directory. Delete it or choose a different path to continue.") } else { + overwriteFile := false + err = huh.NewForm( huh.NewGroup( huh.NewConfirm().Title("The config file already exists. Overwrite it?").Description(fmt.Sprintf("Path: '%s'", configPath)).Value(&overwriteFile), ), ).Run() + if err != nil { + return err + } + if !overwriteFile { + return fmt.Errorf("user aborted") + } } - } - if errors.Is(err, os.ErrNotExist) { + } else if errors.Is(err, os.ErrNotExist) { err = os.MkdirAll(path.Dir(configPath), 0775) } @@ -63,15 +70,10 @@ Leave blank for default` ), ).Run() if err != nil { - return setupConfig{}, err - } - - err = writeConfigurationFile(config, configPath) - if err != nil { - return setupConfig{}, err + return err } - return config, nil + return writeConfigurationFile(config, configPath) } func writeConfigurationFile(config setupConfig, path string) error { diff --git a/main.go b/main.go index cbb93fe..b817abd 100644 --- a/main.go +++ b/main.go @@ -60,11 +60,14 @@ func main() { } if createConfig { - _, err := createConfiguration(configFile) - if err != nil { + err := createConfiguration(configFile) + if err == nil { + log.Info("Configuration file written successfully") + } else if err.Error() == "user aborted" { + log.Info("Configuration setup aborted") + } else { log.Fatalf("Failed to write configuration file: %s", err) } - log.Info("Configuration file written successfully") os.Exit(0) } From 1a3629b154e18af7059188a14202a91bc25b729a Mon Sep 17 00:00:00 2001 From: Sven Luca Hafemann <114884726+SLH335@users.noreply.github.com> Date: Thu, 30 Jan 2025 21:23:53 +0000 Subject: [PATCH 4/4] chore: use /etc/docker as default form config path MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The config file creation form will now place the config file in '/etc/docker/cinder.json' by default, as the systemd service expects the file to be at that location. The path can be changed by also supplying the '-config' flag and setting it to the wanted path. Co-authored-by: René Kuhn --- main.go | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/main.go b/main.go index b817abd..330f655 100644 --- a/main.go +++ b/main.go @@ -55,11 +55,23 @@ func main() { flag.BoolVar(&createConfig, "createConfig", false, "Create config file interactively") flag.Parse() - if configFile == "" { - configFile = "./cinder.json" + log.SetFormatter(&log.TextFormatter{DisableTimestamp: true}) + log.SetOutput(os.Stdout) + + if config.Quiet { + log.SetLevel(log.ErrorLevel) + } + + if config.Debug { + log.SetLevel(log.DebugLevel) + log.Debug("Debug logging enabled") } if createConfig { + if configFile == "" { + configFile = "/etc/docker/cinder.json" + } + err := createConfiguration(configFile) if err == nil { log.Info("Configuration file written successfully") @@ -71,8 +83,9 @@ func main() { os.Exit(0) } - log.SetFormatter(&log.TextFormatter{DisableTimestamp: true}) - log.SetOutput(os.Stdout) + if configFile == "" { + configFile = "./cinder.json" + } content, err := os.ReadFile(configFile) if err != nil { @@ -88,16 +101,6 @@ func main() { log.Fatal("No mountDir configured. Abort.") } - if config.Quiet { - log.SetLevel(log.ErrorLevel) - } - - if config.Debug { - log.SetLevel(log.DebugLevel) - } - - log.Debug("Debug logging enabled") - if config.IdentityEndpoint == "" { log.Fatal("Identity endpoint missing") }