Initial version of go-sqlcmd

.github/workflows/golangci-lint.yml

@@ -0,0 +1,17 @@
+name: golangci-lint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+jobs:
+  golangci-pr:
+    name: lint-pr-changes
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v2
+        with:
+          version: v1.42.0
+          only-new-issues: true

.gitignore

@@ -13,3 +13,8 @@
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+
+coverage.json
+coverage.txt
+coverage.xml
+testresults.xml

.pipelines/TestSql2017.yml

@@ -0,0 +1,80 @@
+pool:
+   vmImage: 'ubuntu-latest'
+
+steps: 
+- task: GoTool@0
+  inputs:
+    version: '1.16.5'
+- task: Go@0
+  displayName: 'Go: get dependencies'
+  inputs:
+    command: 'get'
+    arguments: '-d'
+    workingDirectory: '$(Build.SourcesDirectory)/cmd/sqlcmd'
+
+
+- task: Go@0
+  displayName: 'Go: install gotest.tools/gotestsum'
+  inputs:
+    command: 'custom'
+    customCommand: 'install'
+    arguments: 'gotest.tools/gotestsum@latest'
+    workingDirectory: '$(System.DefaultWorkingDirectory)'
+
+- task: Go@0
+  displayName: 'Go: install github.com/axw/gocov/gocov'
+  inputs:
+    command: 'custom'
+    customCommand: 'install'
+    arguments: 'github.com/axw/gocov/gocov@latest'
+    workingDirectory: '$(System.DefaultWorkingDirectory)'
+
+- task: Go@0
+  displayName: 'Go: install github.com/axw/gocov/gocov'
+  inputs:
+    command: 'custom'
+    customCommand: 'install'
+    arguments: 'github.com/AlekSi/gocov-xml@latest'
+    workingDirectory: '$(System.DefaultWorkingDirectory)'
+
+#Your build pipeline references an undefined variables named SQLPASSWORD. 
+#Create or edit the build pipeline for this YAML file, define the variable on the Variables tab. See https://go.microsoft.com/fwlink/?linkid=865972
+
+- task: Docker@2
+  displayName: 'Run SQL 2017 docker image'
+  inputs:
+    command: run
+    arguments: '-m 2GB -e ACCEPT_EULA=1 -d --name sql2017 -p:1433:1433 -e SA_PASSWORD=$(SQLPASSWORD) mcr.microsoft.com/mssql/server:2017-latest'
+
+- script: |
+    ~/go/bin/gotestsum --junitfile testresults.xml -- ./... -coverprofile=coverage.txt -covermode count
+    ~/go/bin/gocov convert coverage.txt > coverage.json
+    ~/go/bin/gocov-xml < coverage.json > coverage.xml
+    mkdir coverage
+  workingDirectory: '$(Build.SourcesDirectory)'
+  displayName: 'run tests'
+  env:
+    SQLPASSWORD: $(SQLPASSWORD)
+    SQLCMDUSER: sa
+    SQLCMDPASSWORD: $(SQLPASSWORD)
+  continueOnError: true
+- task: PublishTestResults@2
+  displayName: "Publish junit-style results"
+  inputs:
+    testResultsFiles: 'testresults.xml'
+    testResultsFormat: JUnit
+    searchFolder: '$(Build.SourcesDirectory)'
+    testRunTitle: 'SQL 2017 - $(Build.SourceBranchName)'
+  condition: always()
+  continueOnError: true
+
+- task: PublishCodeCoverageResults@1
+  inputs:
+    codeCoverageTool: Cobertura 
+    pathToSources: '$(Build.SourcesDirectory)'
+    summaryFileLocation: $(Build.SourcesDirectory)/**/coverage.xml
+    reportDirectory: $(Build.SourcesDirectory)/**/coverage
+    failIfCoverageEmpty: true
+  condition: always()
+  continueOnError: true
+

.vscode/launch.json

@@ -0,0 +1,27 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Attach using delve",
+            "type": "go",
+            "request": "attach",
+            "preLaunchTask": "delve",
+            "mode": "remote",
+            "remotePath": "${workspaceFolder}",
+            "port" : 23456,
+            "host" : "127.0.0.1",
+            "cwd" : "${workspaceFolder}",
+        },
+        {
+            "name" : "Run query and exit",
+            "type" : "go",
+            "request": "launch",
+            "mode" : "auto",
+            "program": "${fileDirname}",
+            "args" : ["-Q", "\"select 100 as Count\""],
+        }
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,36 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "delve",
+            "type": "shell",
+            "command": "dlv debug --headless --listen=:23456 --api-version=2 \"${workspaceFolder}\"",
+            "isBackground": true,
+            "presentation": {
+                "focus": true,
+                "panel": "dedicated",
+                "clear": false
+            },
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "problemMatcher": {
+                "pattern": {
+                    "regexp": ""
+                },
+                "background": {
+                    "activeOnStart": true,
+                    "beginsPattern": {
+                        "regexp": ".*"
+                    },
+                    "endsPattern": {
+                        "regexp": ".*server listening.*"
+                    }
+                }
+            }
+        }
+    ]
+}

README.md

@@ -1,14 +1,29 @@
-# Project
+# SQL Utilities - Go edition
 
-> This repo has been populated by an initial template to help get you started. Please
-> make sure to update the content to build a great experience for community-building.
+This repo contains command line tools and go packages for working with Microsoft SQL Server, Azure SQL Database, and Azure Synapse.
 
-As the maintainer of this project, please make a few updates:
+## Sqlcmd
 
-- Improving this README.MD file to provide a great experience
-- Updating SUPPORT.MD with content about this project's support experience
-- Understanding the security reporting process in SECURITY.MD
-- Remove this section from the README
+The `sqlcmd` project aims to be a complete port of the native sqlcmd to the `go` language, utilizing the [go-mssqldb](https://github.com/denisenkom/go-mssqldb) driver. For full documentation of the tool, see https://docs.microsoft.com/sql/tools/sqlcmd-utility
+
+### Breaking changes
+
+We will be implementing as many command line switches and behaviors as possible over time. Several switches and behaviors are expected to change in this implementation.
+
+- `-P` switch will be removed. Passwords for SQL authentication can only be provided through these mechanisms:
+
+    -The `SQLCMDPASSWORD` environment variable
+    -The `:CONNECT` command
+    -When prompted, the user can type the password to complete a connection
+
+- `-R` switch will be removed. The go runtime does not provide access to user locale information, and it's not readily available through syscall on all supported platforms.
+- Some behaviors that were kept to maintain compatibility with `OSQL` may be changed, such as alignment of column headers for some data types.
+
+### Packages
+
+#### sqlcmd
+
+#### batch
 
 ## Contributing
 
@@ -26,8 +41,9 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio
 
 ## Trademarks
 
-This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 
-trademarks or logos is subject to and must follow 
+This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
+trademarks or logos is subject to and must follow
 [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
 Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
 Any use of third-party trademarks or logos are subject to those third-party's policies.
+

cmd/sqlcmd/main.go

@@ -0,0 +1,129 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/alecthomas/kong"
+	"github.com/microsoft/go-sqlcmd/pkg/sqlcmd"
+	"github.com/xo/usql/rline"
+)
+
+// SQLCmdArguments defines the command line arguments for sqlcmd
+// The exhaustive list is at https://docs.microsoft.com/sql/tools/sqlcmd-utility?view=sql-server-ver15
+type SQLCmdArguments struct {
+	// Which batch terminator to use. Default is GO
+	BatchTerminator string `short:"c" default:"GO" arghelp:"Specifies the batch terminator. The default value is GO."`
+	// Whether to trust the server certificate on an encrypted connection
+	TrustServerCertificate bool   `short:"C" help:"Implicitly trust the server certificate without validation."`
+	DatabaseName           string `short:"d" help:"This option sets the sqlcmd scripting variable SQLCMDDBNAME. This parameter specifies the initial database. The default is your login's default-database property. If the database does not exist, an error message is generated and sqlcmd exits."`
+	UseTrustedConnection   bool   `short:"E" xor:"uid" help:"Uses a trusted connection instead of using a user name and password to sign in to SQL Server, ignoring any any environment variables that define user name and password."`
+	UserName               string `short:"U" xor:"uid" help:"The login name or contained database user name.  For contained database users, you must provide the database name option"`
+	// Files from which to read query text
+	InputFile  []string `short:"i" xor:"input1, input2" type:"existingFile" help:"Identifies one or more files that contain batches of SQL statements. If one or more files do not exist, sqlcmd will exit. Mutually exclusive with -Q/-q."`
+	OutputFile string   `short:"o" type:"path" help:"Identifies the file that receives output from sqlcmd."`
+	// First query to run in interactive mode
+	InitialQuery string `short:"q" xor:"input1" help:"Executes a query when sqlcmd starts, but does not exit sqlcmd when the query has finished running. Multiple-semicolon-delimited queries can be executed."`
+	// Query to run then exit
+	Query  string `short:"Q" xor:"input2" help:"Executes a query when sqlcmd starts and then immediately exits sqlcmd. Multiple-semicolon-delimited queries can be executed."`
+	Server string `short:"S" help:"[tcp:]server[\\instance_name][,port]Specifies the instance of SQL Server to which to connect. It sets the sqlcmd scripting variable SQLCMDSERVER."`
+	// Disable syscommands with a warning
+	DisableCmdAndWarn bool `short:"X" xor:"syscmd" help:"Disables commands that might compromise system security. Sqlcmd issues a warning and continues."`
+}
+
+// Breaking changes in command line are listed here.
+// Any switch not listed in breaking changes and not also included in SqlCmdArguments just has not been implemented yet
+// 1. -P: Passwords have to be provided through SQLCMDPASSWORD environment variable or typed when prompted
+// 2. -R: Go runtime doesn't expose user locale information and syscall would only enable it on Windows, so we won't try to implement it
+
+var args SQLCmdArguments
+
+func main() {
+	kong.Parse(&args)
+	vars := sqlcmd.InitializeVariables(!args.DisableCmdAndWarn)
+	setVars(vars, &args)
+
+	exitCode, err := run(vars)
+	if err != nil {
+		fmt.Println(err.Error())
+	}
+	os.Exit(exitCode)
+}
+
+// Initializes scripting variables from command line arguments
+func setVars(vars *sqlcmd.Variables, args *SQLCmdArguments) {
+	varmap := map[string]func(*SQLCmdArguments) string{
+		sqlcmd.SQLCMDDBNAME:            func(a *SQLCmdArguments) string { return a.DatabaseName },
+		sqlcmd.SQLCMDLOGINTIMEOUT:      func(a *SQLCmdArguments) string { return "" },
+		sqlcmd.SQLCMDUSEAAD:            func(a *SQLCmdArguments) string { return "" },
+		sqlcmd.SQLCMDWORKSTATION:       func(a *SQLCmdArguments) string { return "" },
+		sqlcmd.SQLCMDSERVER:            func(a *SQLCmdArguments) string { return a.Server },
+		sqlcmd.SQLCMDERRORLEVEL:        func(a *SQLCmdArguments) string { return "" },
+		sqlcmd.SQLCMDPACKETSIZE:        func(a *SQLCmdArguments) string { return "" },
+		sqlcmd.SQLCMDUSER:              func(a *SQLCmdArguments) string { return a.UserName },
+		sqlcmd.SQLCMDSTATTIMEOUT:       func(a *SQLCmdArguments) string { return "" },
+		sqlcmd.SQLCMDHEADERS:           func(a *SQLCmdArguments) string { return "" },
+		sqlcmd.SQLCMDCOLSEP:            func(a *SQLCmdArguments) string { return "" },
+		sqlcmd.SQLCMDCOLWIDTH:          func(a *SQLCmdArguments) string { return "" },
+		sqlcmd.SQLCMDMAXVARTYPEWIDTH:   func(a *SQLCmdArguments) string { return "" },
+		sqlcmd.SQLCMDMAXFIXEDTYPEWIDTH: func(a *SQLCmdArguments) string { return "" },
+	}
+	for varname, set := range varmap {
+		val := set(args)
+		if val != "" {
+			vars.Set(varname, val)
+		}
+	}
+}
+
+func run(vars *sqlcmd.Variables) (exitcode int, err error) {
+	wd, err := os.Getwd()
+	if err != nil {
+		return 1, err
+	}
+	if args.BatchTerminator != "GO" {
+		err = sqlcmd.SetBatchTerminator(args.BatchTerminator)
+		if err != nil {
+			err = fmt.Errorf("invalid batch terminator '%s'", args.BatchTerminator)
+		}
+	}
+	if err != nil {
+		return 1, err
+	}
+
+	iactive := args.InputFile == nil
+	line, err := rline.New(!iactive, "", "")
+	if err != nil {
+		return 1, err
+	}
+	defer line.Close()
+
+	s := sqlcmd.New(line, wd, vars)
+	s.Connect.UseTrustedConnection = args.UseTrustedConnection
+	s.Connect.TrustServerCertificate = args.TrustServerCertificate
+	s.Format = sqlcmd.NewSQLCmdDefaultFormatter(false)
+	if args.OutputFile != "" {
+		err = s.RunCommand(sqlcmd.Commands["OUT"], []string{args.OutputFile})
+		if err != nil {
+			return 1, err
+		}
+	}
+	once := false
+	if args.InitialQuery != "" {
+		s.Query = args.InitialQuery
+	} else if args.Query != "" {
+		once = true
+		s.Query = args.Query
+	}
+	err = s.ConnectDb("", "", "", !iactive)
+	if err != nil {
+		return 1, err
+	}
+	if iactive {
+		err = s.Run(once)
+	}
+	return s.Exitcode, err
+}