added api wrapper cli parser

Author: iolave

cmd/pve_api_wrapper/pve_api_wrapper.go

@@ -2,18 +2,30 @@ package main
 
 import (
 "fmt"
+"log"
 "os"
 
+"github.com/alexflint/go-arg"
 "github.com/iolave/go-proxmox/internal/server"
 )
 
 func main() {
-s := server.New("", "", "localhost", 8006)
+var app server.App
 
-err := s.Start()
+p, err := arg.NewParser(arg.Config{Program: server.NAME}, &app)
 if err != nil {
-fmt.Printf("error: %s", err.Error())
+log.Fatalf("there was an error in the definition of the Go struct: %v\n", err)
+}
+err = p.Parse(os.Args[1:])
+switch {
+case err == arg.ErrHelp: // found "--help" on command line
+p.WriteHelp(os.Stdout)
+os.Exit(0)
+case err != nil:
+fmt.Printf("error: %v\n", err)
+p.WriteUsage(os.Stdout)
 os.Exit(1)
 }
 
+app.Start()
 }

docs/api-wrapper.md

@@ -1,4 +1,6 @@
-The pve api wrapper is an http server ment to be installed on the proxmox host server (but can definitely be installed somewhere else) that wraps the proxmox api and adds missing features to it.
+The pve api wrapper is an http server ment to be installed on the proxmox host server () that wraps the proxmox api and adds missing features to it.
+
+_pve-api-wrapper can definitely be installed somewhere else but some functionalities might not work._
 
 ## Features
 - Proper error responses on failed requests,
@@ -25,11 +27,18 @@ cd go-proxmox-latest
 make build
 ```
 
-
-## Serve
+## Usage
 ```bash
-pve-api-wrapper
+pve-api-wrapper [--version] [--pve-host PVE-HOST] [--pve-port PVE-PORT] [--pve-host PVE-HOST] [--pve-port PVE-PORT] [--crt CRT] [--key KEY]
 ```
+### Options
+- `--version` displays the program version.
+- `--pve-host` proxmox virtual environment host (env:`PVE_HOST`, default:`localhost`).
+- `--pve-port` proxmox virtual environment port (env:`PVE_PORT`, default:`8006`).
+- `--host` api wrapper host (env:`WRAPPER_HOST`, default:`localhost`).
+- `--port` api wrapper port (env:`WRAPPER_PORT`, default:`8443`).
+- `--crt` api wrapper tls crt path (default:`/etc/pve/local/pve-ssl.pem`).
+- `--key` api wrapper tls key path (default:`/etc/pve/local/pve-ssl.key`).
 
 [here]: https://github.com/iolave/go-proxmox/blob/latest/scripts/install.sh
 <!--

docs/go-client/index.md

@@ -1,7 +1,7 @@
 # Go client
 ## Install
 ```bash 
-go get github.com/iolave/go-proxmox@v0.4.0
+go get github.com/iolave/go-proxmox@v0.5.0
 ```
 
 ## Environment variables

go.mod

@@ -2,11 +2,15 @@ module github.com/iolave/go-proxmox
 
 go 1.22.2
 
-require github.com/princjef/gomarkdoc v1.1.0
+require (
+github.com/alexflint/go-arg v1.5.1
+github.com/princjef/gomarkdoc v1.1.0
+)
 
 require (
 github.com/Microsoft/go-winio v0.5.0 // indirect
 github.com/VividCortex/ewma v1.2.0 // indirect
+github.com/alexflint/go-scalar v1.2.0 // indirect
 github.com/cheggaaa/pb/v3 v3.0.8 // indirect
 github.com/emirpasic/gods v1.12.0 // indirect
 github.com/fatih/color v1.11.0 // indirect

go.sum

@@ -7,6 +7,10 @@ github.com/VividCortex/ewma v1.2.0 h1:f58SaIzcDXrSy3kWaHNvuJgJ3Nmz59Zji6XoJR/q1o
 github.com/VividCortex/ewma v1.2.0/go.mod h1:nz4BbCtbLyFDeC9SUHbtcT5644juEuWfUAUnGx7j5l4=
 github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7 h1:uSoVVbwJiQipAclBbw+8quDsfcvFjOpI5iCf4p/cqCs=
 github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7/go.mod h1:6zEj6s6u/ghQa61ZWa/C2Aw3RkjiTBOix7dkqa1VLIs=
+github.com/alexflint/go-arg v1.5.1 h1:nBuWUCpuRy0snAG+uIJ6N0UvYxpxA0/ghA/AaHxlT8Y=
+github.com/alexflint/go-arg v1.5.1/go.mod h1:A7vTJzvjoaSTypg4biM5uYNTkJ27SkNTArtYXnlqVO8=
+github.com/alexflint/go-scalar v1.2.0 h1:WR7JPKkeNpnYIOfHRa7ivM21aWAdHD0gEWHCx+WQBRw=
+github.com/alexflint/go-scalar v1.2.0/go.mod h1:LoFvNMqS1CPrMVltza4LvnGKhaSpc3oyLEBUZVhhS2o=
 github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239 h1:kFOfPq6dUM1hTo4JG6LR5AXSUEsOjtdm0kw0FtQtMJA=
 github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239/go.mod h1:2FmKhYUyUczH0OGQWaF5ceTx0UBShxjsH6f8oGKYe2c=
 github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio=
@@ -111,8 +115,9 @@ github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
-github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/x-cray/logrus-prefixed-formatter v0.5.2 h1:00txxvfBM9muc0jiLIEAkAcIMJzfthRT6usrui8uGmg=
 github.com/x-cray/logrus-prefixed-formatter v0.5.2/go.mod h1:2duySbKsL6M18s5GU7VPsoEPHyzalCE06qoARUCeBBE=
 github.com/xanzy/ssh-agent v0.3.0 h1:wUMzuKtKilRgBAD1sUb8gOwwRr2FGoBVumcjoOACClI=
@@ -173,5 +178,7 @@ gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
+gopkg.in/yaml.v3 v3.0.0 h1:hjy8E9ON/egN1tAYqKb61G10WtihqetD4sz2H+8nIeA=
+gopkg.in/yaml.v3 v3.0.0/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 mvdan.cc/xurls/v2 v2.2.0 h1:NSZPykBXJFCetGZykLAxaL6SIpvbVy/UFEniIfHAa8A=
 mvdan.cc/xurls/v2 v2.2.0/go.mod h1:EV1RMtya9D6G5DMYPGD8zTQzaHet6Jh8gFlRgGRJeO8=

internal/server/cli.go

@@ -0,0 +1,45 @@
+package server
+
+import (
+"fmt"
+"os"
+)
+
+const (
+NAME = "pve-api-wrapper"
+// TODO: read and implement this https://akrabat.com/setting-the-version-of-a-go-application-when-building/
+VERSION = "v0.5.0"
+)
+
+type App struct {
+Version *bool `arg:"--version" help:"display the program version"`
+PVEHost string `arg:"--pve-host,env:PVE_HOST" help:"Proxmox virtual environment host" default:"localhost"`
+PVEPort int `arg:"--pve-port,env:PVE_PORT" help:"Proxmox virtual environment port" default:"8006"`
+Host string `arg:"--pve-host,env:WRAPPER_HOST" help:"API wrapper host" default:"localhost"`
+Port int `arg:"--pve-port,env:WRAPPER_PORT" help:"API wrapper port" default:"8443"`
+TLSCrtPath string `arg:"--crt" help:"API wrapper tls crt path" default:"/etc/pve/local/pve-ssl.pem"`
+TLSKeyPath string `arg:"--key" help:"API wrapper tls key path" default:"/etc/pve/local/pve-ssl.key"`
+}
+
+func (a App) Start() {
+if a.Version != nil && *a.Version == true {
+fmt.Println(VERSION)
+os.Exit(0)
+}
+
+cfg := serverConfig{
+PVEHost: a.PVEHost,
+PVEPort: a.PVEPort,
+Host: a.Host,
+Port: a.Port,
+TLSKey: a.TLSKeyPath,
+TLSCrt: a.TLSCrtPath,
+}
+
+s := New(cfg)
+
+if err := s.Start(); err != nil {
+fmt.Printf("error: %s\n", err.Error())
+os.Exit(1)
+}
+}

internal/server/server.go

@@ -7,25 +7,24 @@ import (
 "net/http"
 )
 
-type Server struct {
-host string
-port int
-tlsKey string
-tlsCrt string
-c *http.Client
-s *http.Server
+type server struct {
+c *http.Client
+s *http.Server
+cfg serverConfig
+}
+
+type serverConfig struct {
+Host string
+Port int
+TLSKey string
+TLSCrt string
 PVEHost string
 PVEPort int
 }
 
-func New(tlsCrt, tlsKey, pveHost string, pvePort int) *Server {
-server := new(Server)
-server.PVEHost = pveHost
-server.PVEPort = pvePort
-server.host = "localhost"
-server.port = 8443
-server.tlsCrt = tlsCrt
-server.tlsKey = tlsKey
+func New(cfg serverConfig) *server {
+server := new(server)
+server.cfg = cfg
 
 c := &http.Client{
 Transport: &http.Transport{
@@ -39,12 +38,12 @@ func New(tlsCrt, tlsKey, pveHost string, pvePort int) *Server {
 return server
 }
 
-func (s *Server) Start() error {
+func (s *server) Start() error {
 log.Println("starting server")
 s.s = &http.Server{
-Addr: fmt.Sprintf("%s:%d", s.host, s.port),
+Addr: fmt.Sprintf("%s:%d", s.cfg.Host, s.cfg.Port),
 Handler: getHandler(s),
 }
 defer s.s.Close()
-return s.s.ListenAndServeTLS(s.tlsCrt, s.tlsKey)
+return s.s.ListenAndServeTLS(s.cfg.TLSCrt, s.cfg.TLSKey)
 }

internal/server/client.go renamed to internal/server/server_client.go

@@ -10,11 +10,11 @@ import (
 "github.com/iolave/go-proxmox/pkg/errors"
 )
 
-func (s *Server) sendPVERequest(sr *http.Request) (*http.Response, *errors.HTTPError) {
+func (s *server) sendPVERequest(sr *http.Request) (*http.Response, *errors.HTTPError) {
 pveUrl, err := url.Parse(fmt.Sprintf(
 "https://%s:%d%s",
-s.PVEHost,
-s.PVEPort,
+s.cfg.PVEHost,
+s.cfg.PVEPort,
 sr.URL.Path,
 ))
 b, err := io.ReadAll(sr.Body)

internal/server/handler.go renamed to internal/server/server_handler.go

@@ -9,7 +9,7 @@ import (
 "github.com/iolave/go-proxmox/pkg/errors"
 )
 
-func getHandler(s *Server) http.HandlerFunc {
+func getHandler(s *server) http.HandlerFunc {
 return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 log.Println(r.Method, r.URL.Path, "started")
 res, httpErr := s.sendPVERequest(r)