Adding logs for debugging (#10)

* Adding logs for debugging

* Fix typo on readme file

* Update zap values

* Update readme file

* Update zap values

* Refactoring code

* Update readme

Author: mchavez

README.md

@@ -84,18 +84,21 @@ Usage:
   baton-sql-server [command]
 
 Available Commands:
+  capabilities       Get connector capabilities
   completion         Generate the autocompletion script for the specified shell
   help               Help about any command
 
 Flags:
-      --client-id string              The client ID used to authenticate with ConductorOne ($BATON_CLIENT_ID)
-      --client-secret string          The client secret used to authenticate with ConductorOne ($BATON_CLIENT_SECRET)
-      --dsn string                    The connection string for connecting to SQL Server ($BATON_DSN)
-  -f, --file string                   The path to the c1z file to sync with ($BATON_FILE) (default "sync.c1z")
-  -h, --help                          help for baton-sql-server
-      --log-format string             The output format for logs: json, console ($BATON_LOG_FORMAT) (default "json")
-      --log-level string              The log level: debug, info, warn, error ($BATON_LOG_LEVEL) (default "info")
-  -v, --version                       version for baton-sql-server
+      --client-id string       The client ID used to authenticate with ConductorOne ($BATON_CLIENT_ID)
+      --client-secret string   The client secret used to authenticate with ConductorOne ($BATON_CLIENT_SECRET)
+      --dsn string             The connection string for connecting to SQL Server ($BATON_DSN)
+  -f, --file string            The path to the c1z file to sync with ($BATON_FILE) (default "sync.c1z")
+  -h, --help                   help for baton-sql-server
+      --log-format string      The output format for logs: json, console ($BATON_LOG_FORMAT) (default "json")
+      --log-level string       The log level: debug, info, warn, error ($BATON_LOG_LEVEL) (default "info")
+  -p, --provisioning           This must be set in order for provisioning actions to be enabled ($BATON_PROVISIONING)
+      --ticketing              This must be set to enable ticketing support ($BATON_TICKETING)
+  -v, --version                version for baton-sql-server
 
 Use "baton-sql-server [command] --help" for more information about a command.
 

cmd/baton-sql-server/config.go

@@ -9,14 +9,14 @@ import (
 )
 
 var (
-	dns = field.StringField("dns",
+	dsn = field.StringField("dsn",
 		field.WithDescription("The connection string for connecting to SQL Server"),
 		field.WithRequired(true))
 )
 
 // validateConfig is run after the configuration is loaded, and should return an error if it isn't valid.
 func validateConfig(_ context.Context, v *viper.Viper) error {
-	if v.GetString(dns.FieldName) == "" {
+	if v.GetString(dsn.FieldName) == "" {
 		return fmt.Errorf("--dsn is required")
 	}
 

cmd/baton-sql-server/main.go

@@ -20,7 +20,7 @@ var version = "dev"
 func main() {
 	ctx := context.Background()
 
-	_, cmd, err := config.DefineConfiguration(ctx, "baton-sql-server", getConnector, []field.SchemaField{dns}, nil)
+	_, cmd, err := config.DefineConfiguration(ctx, "baton-sql-server", getConnector, []field.SchemaField{dsn}, nil)
 	if err != nil {
 		fmt.Fprintln(os.Stderr, err.Error())
 		os.Exit(1)
@@ -41,7 +41,7 @@ func getConnector(ctx context.Context, v *viper.Viper) (types.ConnectorServer, e
 		return nil, err
 	}
 
-	cb, err := connector.New(ctx, v.GetString(dns.FieldName))
+	cb, err := connector.New(ctx, v.GetString(dsn.FieldName))
 	if err != nil {
 		l.Error("error creating connector", zap.Error(err))
 		return nil, err

pkg/mssqldb/permissions.go

@@ -6,6 +6,7 @@ import (
 	"strings"
 
 	"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
+	"go.uber.org/zap"
 )
 
 type PermissionModel struct {
@@ -39,7 +40,10 @@ WHERE perms.state = 'G' OR perms.state = 'W'
 GROUP BY perms.grantee_principal_id, perms.state, principals.name, principals.type 
 ORDER BY perms.grantee_principal_id ASC 
 OFFSET @p1 ROWS FETCH NEXT @p2 ROWS ONLY`)
-
+	l.Debug("ListServerPermissions",
+		zap.String("sql query", sb.String()),
+		zap.Any("args", args),
+	)
 	rows, err := c.db.QueryxContext(ctx, sb.String(), args...)
 	if err != nil {
 		return nil, "", err
@@ -97,7 +101,10 @@ WHERE (perms.state = 'G' OR perms.state = 'W') AND (perms.class = 0 AND perms.ma
 GROUP BY perms.grantee_principal_id, perms.state, principals.name, principals.type 
 ORDER BY perms.grantee_principal_id ASC 
 OFFSET @p1 ROWS FETCH NEXT @p2 ROWS ONLY`)
-
+	l.Debug("ListDatabasePermissions",
+		zap.String("sql query", sb.String()),
+		zap.Any("args", args),
+	)
 	rows, err := c.db.QueryxContext(ctx, sb.String(), args...)
 	if err != nil {
 		return nil, "", err

pkg/mssqldb/roles.go

@@ -51,7 +51,10 @@ WHERE sys.server_role_members.role_principal_id = @p1
 ORDER BY 
   sys.server_principals.principal_id ASC OFFSET @p2 ROWS FETCH NEXT @p3 ROWS ONLY
 `)
-
+	l.Debug("ListServerRolePrincipals",
+		zap.String("sql query", sb.String()),
+		zap.Any("args", args),
+	)
 	rows, err := c.db.QueryxContext(ctx, sb.String(), args...)
 	if err != nil {
 		return nil, "", err
@@ -106,7 +109,10 @@ WHERE type = 'R'
 ORDER BY 
   principal_id ASC OFFSET @p1 ROWS FETCH NEXT @p2 ROWS ONLY
 `)
-
+	l.Debug("ListServerRoles",
+		zap.String("sql query", sb.String()),
+		zap.Any("args", args),
+	)
 	rows, err := c.db.QueryxContext(ctx, sb.String(), args...)
 	if err != nil {
 		return nil, "", err
@@ -161,7 +167,10 @@ WHERE type = 'R'
 ORDER BY 
   principal_id ASC OFFSET @p1 ROWS FETCH NEXT @p2 ROWS ONLY
 `)
-
+	l.Debug("ListDatabaseRoles",
+		zap.String("sql query", sb.String()),
+		zap.Any("args", args),
+	)
 	rows, err := c.db.QueryxContext(ctx, sb.String(), args...)
 	if err != nil {
 		return nil, "", err
@@ -221,7 +230,10 @@ func (c *Client) ListDatabaseRolePrincipals(ctx context.Context, dbName string,
 		dbName,
 		dbName,
 	)
-
+	l.Debug("ListDatabaseRolePrincipals",
+		zap.String("sql query", query),
+		zap.Any("args", args),
+	)
 	rows, err := c.db.QueryxContext(ctx, query, args...)
 	if err != nil {
 		return nil, "", err