[BUG] Addressing Version Check Issue

Fixes #221 ChangeLog: - Removed Dependency of config for version info - Updating documentation for context - Refactoring and removing api calls that are no longer needed
esnet · Dec 14, 2023 · dfb976d · dfb976d
1 parent 7503ab7
commit dfb976d
Show file tree

Hide file tree

Showing 23 changed files with 101 additions and 127 deletions.
diff --git a/Taskfile.yml b/Taskfile.yml
@@ -14,7 +14,7 @@ dotenv: ['.env']
 tasks:
   default:
     cmds:
-      - task: build
+      - task: build_all
   install_tools:
     desc: "Install required Dev tools by GDG"
     cmds:
@@ -53,6 +53,11 @@ tasks:
     desc: "Build linux binary"
     cmds:
       - env GOOS='linux' GOARCH='amd64' go build -ldflags "{{ .LD_FLAGS }}" -o bin/{{ .BIN_NAME }}_linux cmd/gdg/main.go  
+  build_all:
+    desc: "Buiding All binaries" 
+    cmds:
+      - task: build
+      - task: build_generate
   build:
     desc: "Buiding {{ .BIN_NAME }} {{ .VERSION }}" 
     cmds:

diff --git a/cli/backup/backup.go b/cli/backup/backup.go
@@ -21,6 +21,7 @@ limited to clear/delete, list, download and upload.  Any other functionality wil
 			return cd.CobraCommand.Help()
 		},
 		InitCFunc: func(cd *simplecobra.Commandeer, r *support.RootCommand) error {
+			support.InitConfiguration(cd.CobraCommand)
 			r.GrafanaSvc().InitOrganizations()
 			return nil
 		},

diff --git a/cli/commandeer.go b/cli/commandeer.go
@@ -38,7 +38,6 @@ func getNewRootCmd() *support.RootCommand {
 		NameP: "gdg",
 		CommandEntries: []simplecobra.Commander{
 			newVersionCmd(),
-			newContextCmd(),
 			tools.NewToolsCommand(),
 			backup.NewBackupCommand(),
 		},

diff --git a/cli/support/init_cfg.go b/cli/support/init_cfg.go
@@ -0,0 +1,29 @@
+package support
+
+import (
+	"github.com/esnet/gdg/internal/config"
+	appconfig "github.com/esnet/gdg/internal/log"
+	"github.com/spf13/cobra"
+	"os"
+)
+
+// InitConfiguration Loads configuration, and setups fail over case
+func InitConfiguration(cmd *cobra.Command) {
+	configOverride, _ := cmd.Flags().GetString("config")
+	if DefaultConfig == "" {
+		raw, err := os.ReadFile("config/importer-example.yml")
+		if err == nil {
+			DefaultConfig = string(raw)
+		} else {
+			DefaultConfig = ""
+		}
+	}
+
+	//Registers sub CommandsList
+	config.InitConfig(configOverride, DefaultConfig)
+	appconfig.InitializeAppLogger(os.Stdout, os.Stderr, config.Config().IsDebug())
+
+	//Validate current configuration
+	config.Config().GetDefaultGrafanaConfig().Validate()
+
+}
diff --git a/cli/support/root.go b/cli/support/root.go
@@ -4,7 +4,6 @@ import (
 	"context"
 	"errors"
 	"github.com/bep/simplecobra"
-	"github.com/esnet/gdg/internal/config"
 	appconfig "github.com/esnet/gdg/internal/log"
 	"github.com/esnet/gdg/internal/service"
 	"github.com/jedib0t/go-pretty/v6/table"
@@ -63,22 +62,7 @@ func (c *RootCommand) PreRun(this, runner *simplecobra.Commandeer) error {
 
 // initConfiguration Loads configuration, and setups fail over case
 func (c *RootCommand) initConfiguration() {
-	cmd := c.initRunner.CobraCommand
-	configOverride, _ := cmd.Flags().GetString("config")
-	if DefaultConfig == "" {
-		raw, err := os.ReadFile("config/importer-example.yml")
-		if err == nil {
-			DefaultConfig = string(raw)
-		} else {
-			DefaultConfig = ""
-		}
-	}
-	//Registers sub CommandsList
-	config.InitConfig(configOverride, DefaultConfig)
-	appconfig.InitializeAppLogger(os.Stdout, os.Stderr, config.Config().GetGDGConfig().Global.Debug)
-
-	//Validate current configuration
-	config.Config().GetDefaultGrafanaConfig().Validate()
+	appconfig.InitializeAppLogger(os.Stdout, os.Stderr, false)
 
 }
 

diff --git a/cli/context.go → cli/tools/context.go b/cli/context.go → cli/tools/context.go
@@ -1,4 +1,4 @@
-package cli
+package tools
 
 import (
 	"context"

diff --git a/cli/tools/tools.go b/cli/tools/tools.go
@@ -13,10 +13,14 @@ func NewToolsCommand() simplecobra.Commander {
 		NameP:        "tools",
 		Short:        description,
 		Long:         description,
-		CommandsList: []simplecobra.Commander{newDevelCmd(), newUserCommand(), newAuthCmd(), newOrgCommand()},
+		CommandsList: []simplecobra.Commander{newContextCmd(), newDevelCmd(), newUserCommand(), newAuthCmd(), newOrgCommand()},
 		WithCFunc: func(cmd *cobra.Command, r *support.RootCommand) {
 			cmd.Aliases = []string{"t"}
 		},
+		InitCFunc: func(cd *simplecobra.Commandeer, r *support.RootCommand) error {
+			support.InitConfiguration(cd.CobraCommand)
+			return nil
+		},
 		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, rootCmd *support.RootCommand, args []string) error {
 			return cd.CobraCommand.Help()
 		},

diff --git a/cli/version.go b/cli/version.go
@@ -7,19 +7,18 @@ import (
 	"github.com/esnet/gdg/cli/support"
 	"github.com/esnet/gdg/internal/version"
 	"github.com/spf13/cobra"
-	"os"
+	"log/slog"
 )
 
 func newVersionCmd() simplecobra.Commander {
 	return &support.SimpleCommand{
 		NameP: "version",
 		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, r *support.RootCommand, args []string) error {
-			stdout := os.Stdout
-			fmt.Fprintf(stdout, "Build Date: %s\n", version.BuildDate)
-			fmt.Fprintf(stdout, "Git Commit: %s\n", version.GitCommit)
-			fmt.Fprintf(stdout, "Version: %s\n", version.Version)
-			fmt.Fprintf(stdout, "Go Version: %s\n", version.GoVersion)
-			fmt.Fprintf(stdout, "OS / Arch: %s\n", version.OsArch)
+			slog.Info(fmt.Sprintf("Build Date: %s", version.BuildDate))
+			slog.Info(fmt.Sprintf("Git Commit: %s", version.GitCommit))
+			slog.Info(fmt.Sprintf("Version: %s", version.Version))
+			slog.Info(fmt.Sprintf("Go Version: %s", version.GoVersion))
+			slog.Info(fmt.Sprintf("OS / Arch: %s", version.OsArch))
 			return nil
 		},
 		WithCFunc: func(cmd *cobra.Command, r *support.RootCommand) {

diff --git a/cmd/gdg/main.go b/cmd/gdg/main.go
@@ -1,7 +1,6 @@
 package main
 
 import (
-	_ "embed"
 	"github.com/esnet/gdg/cli"
 	"github.com/esnet/gdg/cli/support"
 	"log"

diff --git a/internal/api/accessControl.go b/internal/api/accessControl.go
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -171,7 +171,7 @@ func (app *GDGAppConfiguration) GetContextMap() map[string]interface{} {
 }
 
 var (
-	configData        *Configuration
+	configData        = new(Configuration)
 	configSearchPaths = []string{"config", ".", "../config", "../../config", "/etc/gdg"}
 )
 
@@ -196,7 +196,10 @@ func (s *Configuration) GetContexts() map[string]*GrafanaConfig {
 
 // IsDebug returns true if debug mode is enabled
 func (s *Configuration) IsDebug() bool {
-	return s.GetViperConfig(ViperGdgConfig).GetBool("global.debug")
+	if val := s.GetViperConfig(ViperGdgConfig); val != nil {
+		return val.GetBool("global.debug")
+	}
+	return false
 }
 
 // IgnoreSSL returns true if SSL errors should be ignored

diff --git a/internal/service/connection_permissions.go b/internal/service/connection_permissions.go
@@ -128,7 +128,6 @@ func (s *DashNGoImpl) UploadConnectionPermissions(filter filters.Filter) []strin
 				p.SetBuiltinRole(tools.PtrOf(entry.BuiltInRole))
 			}
 			_, err = s.client.DatasourcePermissions.AddPermission(p, s.getAuth())
-			//err = s.extended.AddConnectionPermission(p)
 			if err != nil {
 				slog.Error("Failed to update folder permissions")
 			} else {

diff --git a/internal/service/mocks/AuthenticationApi.go b/internal/service/mocks/AuthenticationApi.go
diff --git a/internal/service/mocks/GrafanaService.go b/internal/service/mocks/GrafanaService.go
diff --git a/internal/service/mocks/ServiceAccountApi.go b/internal/service/mocks/ServiceAccountApi.go
diff --git a/internal/service/serviceaccounts.go b/internal/service/serviceaccounts.go
@@ -2,9 +2,9 @@ package service
 
 import (
 	"fmt"
+	"github.com/esnet/gdg/internal/types"
 	"log/slog"
 
-	"github.com/esnet/gdg/internal/api"
 	"github.com/esnet/gdg/internal/tools"
 	"github.com/grafana/grafana-openapi-client-go/client/service_accounts"
 	"github.com/grafana/grafana-openapi-client-go/models"
@@ -13,7 +13,7 @@ import (
 )
 
 type ServiceAccountApi interface {
-	ListServiceAccounts() []*api.ServiceAccountDTOWithTokens
+	ListServiceAccounts() []*types.ServiceAccountDTOWithTokens
 	ListServiceAccountsTokens(id int64) ([]*models.TokenDTO, error)
 	DeleteAllServiceAccounts() []string
 	DeleteServiceAccountTokens(serviceId int64) []string
@@ -52,7 +52,7 @@ func (s *DashNGoImpl) CreateServiceAccountToken(serviceAccountId int64, name str
 	return token.GetPayload(), nil
 }
 
-func (s *DashNGoImpl) ListServiceAccounts() []*api.ServiceAccountDTOWithTokens {
+func (s *DashNGoImpl) ListServiceAccounts() []*types.ServiceAccountDTOWithTokens {
 	p := service_accounts.NewSearchOrgServiceAccountsWithPagingParams()
 	p.Disabled = tools.PtrOf(false)
 	p.Perpage = tools.PtrOf(int64(5000))
@@ -62,8 +62,8 @@ func (s *DashNGoImpl) ListServiceAccounts() []*api.ServiceAccountDTOWithTokens {
 		log.Fatal("unable to retrieve service accounts")
 	}
 	data := resp.GetPayload()
-	result := lo.Map(data.ServiceAccounts, func(entity *models.ServiceAccountDTO, _ int) *api.ServiceAccountDTOWithTokens {
-		t := api.ServiceAccountDTOWithTokens{
+	result := lo.Map(data.ServiceAccounts, func(entity *models.ServiceAccountDTO, _ int) *types.ServiceAccountDTOWithTokens {
+		t := types.ServiceAccountDTOWithTokens{
 			ServiceAccount: entity,
 		}
 		return &t

diff --git a/internal/api/models.go → internal/types/models.go b/internal/api/models.go → internal/types/models.go
@@ -1,4 +1,4 @@
-package api
+package types
 
 import "github.com/grafana/grafana-openapi-client-go/models"
 

diff --git a/website/content/en/docs/gdg/configuration.md b/website/content/en/docs/gdg/configuration.md
@@ -271,7 +271,7 @@ The pattern for GDG's is as follows:  `GDG_SECTION__SECTION__keyname`
 For example if I want to set the context name to a different value I can use:
 
 ```sh
-GDG_CONTEXT_NAME="testing" gdg ctx show ## Which will override the value from the context file.
+GDG_CONTEXT_NAME="testing" gdg tools ctx show ## Which will override the value from the context file.
 GDG_CONTEXTS__TESTING__URL="www.google.com" Will override the URL with the one provided.
  ```
 

diff --git a/website/content/en/docs/gdg/getting_started.md b/website/content/en/docs/gdg/getting_started.md
@@ -7,7 +7,7 @@ weight: 13
 
 You can create new context configuration using an interactive setup.
 ```
-$ ./bin/gdg ctx new mycontext
+$ ./bin/gdg tools ctx new mycontext
 ```
 
 When creating a new context, you will be asked for authorization type, your default datasource and username/password, along with which folders you wish to manage under the context. You have three options:

diff --git a/website/content/en/docs/gdg/installation.md b/website/content/en/docs/gdg/installation.md
@@ -81,7 +81,7 @@ You can verify the version by running `gdg version`.
 
 ## Configuration
 
-You can then create a simple configuration using `gdg ctx new` which will do a best effort to guide to setup a basic config that will get you up and going or read the more detailed documentation that can be found [here](/gdg/docs/gdg/configuration/)
+You can then create a simple configuration using `gdg tools ctx new` which will do a best effort to guide to setup a basic config that will get you up and going or read the more detailed documentation that can be found [here](/gdg/docs/gdg/configuration/)
 
 
 **NOTE**: wizard doesn't currently support ALL features but it should help you get a head start.