-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* update go modules * refactor and implement features * fix yaml tag * add autofit tests
- Loading branch information
Showing
18 changed files
with
316 additions
and
97 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,101 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "log" | ||
| "os" | ||
| "testing" | ||
|
|
||
| "github.com/grafana/grafana-kiosk/pkg/kiosk" | ||
| "github.com/ilyakaznacheev/cleanenv" | ||
| . "github.com/smartystreets/goconvey/convey" | ||
| ) | ||
|
|
||
| // TestKiosk checks kiosk command. | ||
| func TestKioskCommand(t *testing.T) { | ||
| Convey("Given Kiosk CMD", t, func() { | ||
| Convey("cmd should...", func() { | ||
| So(true, ShouldBeTrue) | ||
| func TestMain(t *testing.T) { | ||
| Convey("Given Default Configuration", t, func() { | ||
| cfg := kiosk.Config{ | ||
| BuildInfo: kiosk.BuildInfo{ | ||
| Version: "1.0.0", | ||
| }, | ||
| General: kiosk.General{ | ||
| AutoFit: true, | ||
| LXDEEnabled: true, | ||
| LXDEHome: "/home/pi", | ||
| Mode: "full", | ||
| WindowPosition: "0,0", | ||
| WindowSize: "1920,1080", | ||
| ScaleFactor: "1.0", | ||
| }, | ||
| Target: kiosk.Target{ | ||
| IgnoreCertificateErrors: false, | ||
| IsPlayList: false, | ||
| UseMFA: false, | ||
| LoginMethod: "local", | ||
| Password: "admin", | ||
| URL: "http://localhost:3000", | ||
| Username: "admin", | ||
| }, | ||
| GoAuth: kiosk.GoAuth{ | ||
| AutoLogin: false, | ||
| UsernameField: "user", | ||
| PasswordField: "password", | ||
| }, | ||
| IDToken: kiosk.IDToken{ | ||
| KeyFile: "/tmp/key.json", | ||
| Audience: "clientid", | ||
| }, | ||
| APIKey: kiosk.APIKey{ | ||
| APIKey: "abc", | ||
| }, | ||
| } | ||
| Convey("General Options", func() { | ||
| Convey("Parameter - autofit", func() { | ||
| oldArgs := os.Args | ||
| defer func() { os.Args = oldArgs }() | ||
| os.Args = []string{"grafana-kiosk", ""} | ||
| // starts out default true | ||
| result := ProcessArgs(cfg) | ||
| So(result.AutoFit, ShouldBeTrue) | ||
| // flag to set it false | ||
| os.Args = []string{ | ||
| "grafana-kiosk", | ||
| "--autofit=false", | ||
| } | ||
| result = ProcessArgs(cfg) | ||
| So(result.AutoFit, ShouldBeFalse) | ||
| }) | ||
|
|
||
| Convey("Environment - autofit", func() { | ||
| oldArgs := os.Args | ||
| defer func() { os.Args = oldArgs }() | ||
| os.Args = []string{"grafana-kiosk", ""} | ||
| os.Setenv("KIOSK_AUTOFIT", "false") | ||
| cfg := kiosk.Config{} | ||
| if err := cleanenv.ReadEnv(&cfg); err != nil { | ||
| log.Println("Error reading config from environment", err) | ||
| } | ||
| So(cfg.General.AutoFit, ShouldBeFalse) | ||
| }) | ||
| }) | ||
| // end of general options | ||
|
|
||
| Convey("Anonymous Login", func() { | ||
| oldArgs := os.Args | ||
| defer func() { os.Args = oldArgs }() | ||
| os.Args = []string{"grafana-kiosk", ""} | ||
| result := ProcessArgs(cfg) | ||
| So(result.LoginMethod, ShouldEqual, "anon") | ||
| So(result.URL, ShouldEqual, "https://play.grafana.org") | ||
| So(result.AutoFit, ShouldBeTrue) | ||
| }) | ||
| Convey("Local Login", func() { | ||
| oldArgs := os.Args | ||
| defer func() { os.Args = oldArgs }() | ||
| os.Args = []string{"grafana-kiosk", "-login-method", "local"} | ||
| result := ProcessArgs(cfg) | ||
| So(result.LoginMethod, ShouldEqual, "local") | ||
| So(result.URL, ShouldEqual, "https://play.grafana.org") | ||
| So(result.AutoFit, ShouldBeTrue) | ||
| }) | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,60 @@ | ||
| package kiosk | ||
|
|
||
| // BuildInfo contains the build version | ||
| type BuildInfo struct { | ||
| Version string `yaml:"version,omitempty"` | ||
| } | ||
|
|
||
| // General non-site specific configuations | ||
| type General struct { | ||
| AutoFit bool `yaml:"autofit" env:"KIOSK_AUTOFIT" env-default:"true" env-description:"fit panels to screen"` | ||
| DebugEnabled bool `yaml:"debug" env:"KIOSK_DEBUG" env-default:"false" env-description:"enables debug output"` | ||
| GPUEnabled bool `yaml:"gpu-enabled" env:"KIOSK_GPU_ENABLED" env-default:"false" env-description:"disable GPU support"` | ||
| LXDEEnabled bool `yaml:"lxde" env:"KIOSK_LXDE_ENABLED" env-default:"false" env-description:"initialize LXDE for kiosk mode"` | ||
| LXDEHome string `yaml:"lxde-home" env:"KIOSK_LXDE_HOME" env-default:"/home/pi" env-description:"path to home directory of LXDE user running X Server"` | ||
| Mode string `yaml:"kiosk-mode" env:"KIOSK_MODE" env-default:"full" env-description:"[full|tv|disabled]"` | ||
| OzonePlatform string `yaml:"ozone-platform" env:"KIOSK_OZONE_PLATFORM" env-default:"" env-description:"Set ozone-platform option (wayland|cast|drm|wayland|x11)"` | ||
| PageLoadDelayMS int64 `yaml:"page-load-delay-ms" env:"KIOSK_PAGE_LOAD_DELAY_MS" env-default:"2000" env-description:"milliseconds to wait before expecting page load"` | ||
| ScaleFactor string `yaml:"scale-factor" env:"KIOSK_SCALE_FACTOR" env-default:"1.0" env-description:"Scale factor, like zoom"` | ||
| WindowPosition string `yaml:"window-position" env:"KIOSK_WINDOW_POSITION" env-default:"0,0" env-description:"Top Left Position of Kiosk"` | ||
| WindowSize string `yaml:"window-size" env:"KIOSK_WINDOW_SIZE" env-default:"" env-description:"Size of Kiosk in pixels (width,height)"` | ||
| } | ||
|
|
||
| // Target the dashboard/playlist details | ||
| type Target struct { | ||
| IgnoreCertificateErrors bool `yaml:"ignore-certificate-errors" env:"KIOSK_IGNORE_CERTIFICATE_ERRORS" env-description:"ignore SSL/TLS certificate errors" env-default:"false"` | ||
| IsPlayList bool `yaml:"playlist" env:"KIOSK_IS_PLAYLIST" env-default:"false" env-description:"URL is a playlist"` | ||
| LoginMethod string `yaml:"login-method" env:"KIOSK_LOGIN_METHOD" env-default:"anon" env-description:"[anon|local|gcom|goauth|idtoken|apikey]"` | ||
| Password string `yaml:"password" env:"KIOSK_LOGIN_PASSWORD" env-default:"guest" env-description:"password"` | ||
| URL string `yaml:"URL" env:"KIOSK_URL" env-default:"https://play.grafana.org" env-description:"URL to Grafana server"` | ||
| Username string `yaml:"username" env:"KIOSK_LOGIN_USER" env-default:"guest" env-description:"username"` | ||
| UseMFA bool `yaml:"use-mfa" env:"KIOSK_USE_MFA" env-default:"false" env-description:"MFA is enabled for given account"` | ||
| } | ||
|
|
||
| // GoAuth OAuth | ||
| type GoAuth struct { | ||
| AutoLogin bool `yaml:"auto-login" env:"KIOSK_GOAUTH_AUTO_LOGIN" env-description:"[false|true]"` | ||
| UsernameField string `yaml:"fieldname-username" env:"KIOSK_GOAUTH_FIELD_USER" env-description:"Username html input name value"` | ||
| PasswordField string `yaml:"fieldname-password" env:"KIOSK_GOAUTH_FIELD_PASSWORD" env-description:"Password html input name value"` | ||
| } | ||
|
|
||
| // IDToken token based login | ||
| type IDToken struct { | ||
| KeyFile string `yaml:"idtoken-keyfile" env:"KIOSK_IDTOKEN_KEYFILE" env-default:"key.json" env-description:"JSON Credentials for idtoken"` | ||
| Audience string `yaml:"idtoken-audience" env:"KIOSK_IDTOKEN_AUDIENCE" env-description:"Audience for idtoken, tpyically your oauth client id"` | ||
| } | ||
|
|
||
| // APIKey APIKey for login | ||
| type APIKey struct { | ||
| APIKey string `yaml:"apikey" env:"KIOSK_APIKEY_APIKEY" env-description:"APIKEY"` | ||
| } | ||
|
|
||
| // Config configuration for backend. | ||
| type Config struct { | ||
| BuildInfo struct { | ||
| Version string `yaml:"version,omitempty"` | ||
| } | ||
| General struct { | ||
| AutoFit bool `yaml:"autofit" env:"KIOSK_AUTOFIT" env-default:"true" env-description:"fit panels to screen"` | ||
| LXDEEnabled bool `yaml:"lxde" env:"KIOSK_LXDE_ENABLED" env-default:"false" env-description:"initialize LXDE for kiosk mode"` | ||
| LXDEHome string `yaml:"lxde-home" env:"KIOSK_LXDE_HOME" env-default:"/home/pi" env-description:"path to home directory of LXDE user running X Server"` | ||
| Mode string `yaml:"kiosk-mode" env:"KIOSK_MODE" env-default:"full" env-description:"[full|tv|disabled]"` | ||
| WindowPosition string `yaml:"window-position" env:"KIOSK_WINDOW_POSITION" env-default:"0,0" env-description:"Top Left Position of Kiosk"` | ||
| WindowSize string `yaml:"window-size" env:"KIOSK_WINDOW_SIZE" env-default:"" env-description:"Size of Kiosk in pixels (width,height)"` | ||
| ScaleFactor string `yaml:"scale-factor" env:"KIOSK_SCALE_FACTOR" env-default:"1.0" env-description:"Scale factor, like zoom"` | ||
| } `yaml:"general"` | ||
| Target struct { | ||
| IgnoreCertificateErrors bool `yaml:"ignore-certificate-errors" env:"KIOSK_IGNORE_CERTIFICATE_ERRORS" env-description:"ignore SSL/TLS certificate errors" env-default:"false"` | ||
| IsPlayList bool `yaml:"playlist" env:"KIOSK_IS_PLAYLIST" env-default:"false" env-description:"URL is a playlist"` | ||
| UseMFA bool `yaml:"use-mfa" env:"KIOSK_USE_MFA" env-default:"false" env-description:"MFA is enabled for given account"` | ||
| LoginMethod string `yaml:"login-method" env:"KIOSK_LOGIN_METHOD" env-default:"anon" env-description:"[anon|local|gcom|goauth|idtoken|apikey]"` | ||
| Password string `yaml:"password" env:"KIOSK_LOGIN_PASSWORD" env-default:"guest" env-description:"password"` | ||
| URL string `yaml:"URL" env:"KIOSK_URL" env-default:"https://play.grafana.org" env-description:"URL to Grafana server"` | ||
| Username string `yaml:"username" env:"KIOSK_LOGIN_USER" env-default:"guest" env-description:"username"` | ||
| } `yaml:"target"` | ||
| GOAUTH struct { | ||
| AutoLogin bool `yaml:"auto-login" env:"KIOSK_GOAUTH_AUTO_LOGIN" env-description:"[false|true]"` | ||
| UsernameField string `yaml:"fieldname-username" env:"KIOSK_GOAUTH_FIELD_USER" env-description:"Username html input name value"` | ||
| PasswordField string `yaml:"fieldname-password" env:"KIOSK_GOAUTH_FIELD_PASSWORD" env-description:"Password html input name value"` | ||
| } `yaml:"goauth"` | ||
| IDTOKEN struct { | ||
| KeyFile string `yaml:"idtoken-keyfile" env:"KIOSK_IDTOKEN_KEYFILE" env-default:"key.json" env-description:"JSON Credentials for idtoken"` | ||
| Audience string `yaml:"idtoken-audience" env:"KIOSK_IDTOKEN_AUDIENCE" env-description:"Audience for idtoken, tpyically your oauth client id"` | ||
| } `yaml:"idtoken"` | ||
| APIKEY struct { | ||
| Apikey string `yaml:"apikey" env:"KIOSK_APIKEY_APIKEY" env-description:"APIKEY"` | ||
| } `yaml:"apikey"` | ||
| BuildInfo BuildInfo `yaml:"buildinfo"` | ||
| General General `yaml:"general"` | ||
| Target Target `yaml:"target"` | ||
| GoAuth GoAuth `yaml:"goauth"` | ||
| IDToken IDToken `yaml:"idtoken"` | ||
| APIKey APIKey `yaml:"apikey"` | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.