Merge branch 'master' into python-publish-workflow

Author: dolphin1999

Diff for: .github/workflows/gh-pages.yaml

@@ -0,0 +1,36 @@
+name: github pages
+
+on:
+  push:
+    branches:
+      - gh-pages  # Set a branch that will trigger a deployment
+  pull_request:
+    branches:
+      - gh-pages
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: gh-pages
+          submodules: true  # Fetch Hugo themes (true OR recursive)
+          fetch-depth: 0    # Fetch all history for .GitInfo and .Lastmod
+
+      - name: Setup Hugo
+        uses: peaceiris/actions-hugo@v2
+        with:
+          hugo-version: '0.79.1'
+          # extended: true
+
+      - name: Build
+        run: cd src && hugo --minify && cd ..
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.ref == 'refs/heads/gh-pages'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: .

Diff for: .github/workflows/go-sql-tests.yaml

@@ -0,0 +1,45 @@
+name: go packages test
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - go/**
+  pull_request:
+    paths:
+      - go/**
+
+jobs:
+  unittests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: 1.19
+
+    - name: Build
+      run: go build -v ./...
+      working-directory: ./go/database/sql
+
+    - name: Test go-sql
+      run: go test -v ./...
+      working-directory: ./go/database/sql
+
+  gofmt:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.19
+
+      # Verify go fmt standards are used
+      - name: Format
+        run: if [ "$(gofmt -s -l . | wc -l)" -gt 0 ]; then exit 1; fi
+

Diff for: .github/workflows/unit-tests.yaml

@@ -9,12 +9,14 @@ on:
       - php/sqlcommenter-php/samples/sqlcommenter-laravel/**
       - python/sqlcommenter-python/**
       - nodejs/**
+      - go/**
   pull_request:
     paths-ignore:
       - php/sqlcommenter-php/packages/sqlcommenter-laravel/**
       - php/sqlcommenter-php/samples/sqlcommenter-laravel/**
       - python/sqlcommenter-python/**
       - nodejs/**
+      - go/**
 
 jobs:
   unittests:

Diff for: .gitignore

@@ -1,2 +1,3 @@
 php/sqlcommenter-php/packages/sqlcommenter-laravel/vendor/*
-.idea/**
+.idea/**
+.DS_Store

Diff for: go/core/README.md

@@ -0,0 +1,45 @@
+# SQLCommenter Core  [In development]
+
+SQLcommenter is a plugin/middleware/wrapper to augment application related information/tags with SQL Statements that can be used later to correlate user code with SQL statements.
+
+This package contains configuration options, framework interface and support functions for all the sqlcommenter go modules
+
+## Installation
+
+This is a support package and will be installed indirectly by other go sqlcommenter packages
+
+## Usages
+
+### Configuration
+
+Users are given control over what tags they want to append by using `core.CommenterConfig` struct.
+
+```go
+type CommenterConfig struct {
+    EnableDBDriver    bool
+    EnableRoute       bool
+    EnableFramework   bool
+    EnableController  bool
+    EnableAction      bool
+    EnableTraceparent bool
+    EnableApplication bool
+}
+```
+
+Users can also set the values for some static tags by using `core.StaticTags` struct.
+
+```go
+type StaticTags struct {
+    Application string
+    DriverName  string
+}
+```
+
+These two structs together form the `core.CommenterOptions` struct, which is used by [sqlcommenter/go/database/sql](../database/sql/README.md).
+
+```go
+type CommenterOptions struct {
+    Config CommenterConfig
+    Tags   StaticTags
+}
+```

Diff for: go/core/core.go

@@ -0,0 +1,111 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package core
+
+import (
+	"context"
+	"fmt"
+	"net/url"
+	"reflect"
+	"runtime"
+	"sort"
+	"strings"
+
+	"go.opentelemetry.io/otel/propagation"
+)
+
+const (
+	Route       string = "route"
+	Controller  string = "controller"
+	Action      string = "action"
+	Framework   string = "framework"
+	Driver      string = "db_driver"
+	Traceparent string = "traceparent"
+	Application string = "application"
+)
+
+type CommenterConfig struct {
+	EnableDBDriver    bool
+	EnableRoute       bool
+	EnableFramework   bool
+	EnableController  bool
+	EnableAction      bool
+	EnableTraceparent bool
+	EnableApplication bool
+}
+
+type StaticTags struct {
+	Application string
+	DriverName  string
+}
+
+type CommenterOptions struct {
+	Config CommenterConfig
+	Tags   StaticTags
+}
+
+func encodeURL(k string) string {
+	return url.QueryEscape(string(k))
+}
+
+func GetFunctionName(i interface{}) string {
+	if i == nil {
+		return ""
+	}
+	return runtime.FuncForPC(reflect.ValueOf(i).Pointer()).Name()
+}
+
+func ConvertMapToComment(tags map[string]string) string {
+	var sb strings.Builder
+	i, sz := 0, len(tags)
+
+	//sort by keys
+	sortedKeys := make([]string, 0, len(tags))
+	for k := range tags {
+		sortedKeys = append(sortedKeys, k)
+	}
+	sort.Strings(sortedKeys)
+
+	for _, key := range sortedKeys {
+		if i == sz-1 {
+			sb.WriteString(fmt.Sprintf("%s=%v", encodeURL(key), encodeURL(tags[key])))
+		} else {
+			sb.WriteString(fmt.Sprintf("%s=%v,", encodeURL(key), encodeURL(tags[key])))
+		}
+		i++
+	}
+	return sb.String()
+}
+
+func ExtractTraceparent(ctx context.Context) propagation.MapCarrier {
+	// Serialize the context into carrier
+	textMapPropogator := propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{})
+	carrier := propagation.MapCarrier{}
+	textMapPropogator.Inject(ctx, carrier)
+	return carrier
+}
+
+type RequestTagsProvider interface {
+	Route() string
+	Action() string
+	Framework() string
+}
+
+func ContextInject(ctx context.Context, h RequestTagsProvider) context.Context {
+	ctx = context.WithValue(ctx, Route, h.Route())
+	ctx = context.WithValue(ctx, Action, h.Action())
+	ctx = context.WithValue(ctx, Framework, h.Framework())
+	return ctx
+}

Diff for: go/core/go.mod

@@ -0,0 +1,7 @@
+module github.com/google/sqlcommenter/go/core
+
+go 1.19
+
+require go.opentelemetry.io/otel v1.11.1
+
+require go.opentelemetry.io/otel/trace v1.11.1 // indirect

Diff for: go/core/go.sum

@@ -0,0 +1,15 @@
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/go-logr/logr v1.2.3 h1:2DntVwHkVopvECVRSlL5PSo9eG+cAkDCuckLubN+rq0=
+github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
+github.com/google/go-cmp v0.5.8 h1:e6P7q2lk1O+qJJb4BtCQXlK8vWEO8V1ZeuEdJNOqZyg=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/stretchr/testify v1.7.1 h1:5TQK59W5E3v0r2duFAb7P95B6hEeOyEnHRa8MjYSMTY=
+go.opentelemetry.io/otel v1.10.0 h1:Y7DTJMR6zs1xkS/upamJYk0SxxN4C9AqRd77jmZnyY4=
+go.opentelemetry.io/otel v1.10.0/go.mod h1:NbvWjCthWHKBEUMpf0/v8ZRZlni86PpGFEMA9pnQSnQ=
+go.opentelemetry.io/otel v1.11.1 h1:4WLLAmcfkmDk2ukNXJyq3/kiz/3UzCaYq6PskJsaou4=
+go.opentelemetry.io/otel v1.11.1/go.mod h1:1nNhXBbWSD0nsL38H6btgnFN2k4i0sNLHNNMZMSbUGE=
+go.opentelemetry.io/otel/trace v1.10.0 h1:npQMbR8o7mum8uF95yFbOEJffhs1sbCOfDh8zAJiH5E=
+go.opentelemetry.io/otel/trace v1.10.0/go.mod h1:Sij3YYczqAdz+EhmGhE6TpTxUO5/F/AzrK+kxfGqySM=
+go.opentelemetry.io/otel/trace v1.11.1 h1:ofxdnzsNrGBYXbP7t7zpUK281+go5rF7dvdIZXF8gdQ=
+go.opentelemetry.io/otel/trace v1.11.1/go.mod h1:f/Q9G7vzk5u91PhbmKbg1Qn0rzH1LJ4vbPHFGkTPtOk=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=

Diff for: go/database/sql/README.md

@@ -0,0 +1,68 @@
+# go-sql-driver
+
+SQLcommenter is a plugin/middleware/wrapper to augment application related information/tags with SQL Statements that can be used later to correlate user code with SQL statements.
+
+## Installation
+
+```shell
+go get -u github.com/google/sqlcommenter/go/database/sql
+```
+
+## Usage
+
+Please use the sqlcommenter's default go-sql database driver to execute statements. 
+Due to inherent nature of Go, the safer way to pass information from framework to database driver is via `context`. So, it is recommended to use the context based methods of `DB` interface like `QueryContext`, `ExecContext` and `PrepareContext`. 
+
+```go
+import (
+    gosql "github.com/google/sqlcommenter/go/database/sql"
+    sqlcommentercore "github.com/google/sqlcommenter/go/core"
+    _ "github.com/lib/pq" // or any other database driver
+)
+
+db, err := gosql.Open("<driver>", "<connectionString>", sqlcommentercore.CommenterOptions{
+    Config: sqlcommentercore.CommenterConfig{<flag>:bool}
+    Tags  : sqlcommentercore.StaticTags{<tag>: string} // optional
+})
+```
+
+### Configuration
+
+Users are given control over what tags they want to append by using `core.CommenterOptions` struct.
+
+```go
+type CommenterOptions struct {
+    EnableDBDriver    bool
+    EnableTraceparent bool   // OpenTelemetry trace information
+    EnableRoute       bool   // applicable for web frameworks
+    EnableFramework   bool   // applicable for web frameworks
+    EnableController  bool   // applicable for web frameworks
+    EnableAction      bool   // applicable for web frameworks
+    EnableApplication bool   // applicable for web frameworks
+}
+```
+
+Users can also provide static tags they want to use by using `core.StaticTags` struct. These tags are optional. If not provided, the `Application` tag will get auto-populated from the user-project's module-name in `go.mod`. `DriverName` is set to the driver-name provided in `gosql.Open(driverName, ...)` call.
+
+```go
+type StaticTags struct {
+    Application string
+    DriverName  string
+}
+```
+
+The driver will try to use the module-name from the project's `go.mod` as the application name if `EnableApplication` is `true` and no `Application` string is provided (works correctly for compiled go applications).
+
+
+### Framework Supported
+* [http/net](../../net/http/README.md) - basic support
+* [gorrila/mux](../../gorrila//mux/README.md) - proper support
+
+
+## Options
+
+With Go SqlCommenter, we have configuration to choose which tags to be appended to the comment.
+
+| Options    | Included by default? | go-sql-driver                                            |
+| ---------- | -------------------- | -------------------------------------------------------- |
+| `DBDriver` |                      | [ go-sql-driver](https://pkg.go.dev/database/sql/driver) |