initial implementation of test helpers project (#1)

Author: eli-darkly

.circleci/config.yml

@@ -0,0 +1,100 @@
+version: 2.1
+
+orbs:
+  win: circleci/[email protected]
+
+workflows:
+  workflow:
+    jobs:
+      - go-test:
+          name: Go 1.14
+          docker-image: circleci/golang:1.14
+      - go-test:
+          name: Go 1.13
+          docker-image: circleci/golang:1.13
+      - go-test:
+          name: Go 1.12
+          docker-image: circleci/golang:1.12
+      - go-test:
+          name: Go 1.11
+          docker-image: circleci/golang:1.11
+      - go-test:
+          name: Go 1.10
+          docker-image: circleci/golang:1.10
+          run-lint: false # the version of golangci-lint we're using doesn't work with older Go versions
+      - go-test:
+          name: Go 1.9
+          docker-image: circleci/golang:1.9
+          run-lint: false # the version of golangci-lint we're using doesn't work with older Go versions
+      - go-test:
+          name: Go 1.8
+          docker-image: circleci/golang:1.8
+          run-lint: false # the version of golangci-lint we're using doesn't work with older Go versions
+      - go-test-windows:
+          name: Windows
+
+jobs:
+  go-test:
+    parameters:
+      run-lint:
+        type: boolean
+        default: true
+      docker-image:
+        type: string
+
+    docker:
+      - image: <<parameters.docker-image>>
+        environment:
+          CIRCLE_TEST_REPORTS: /tmp/circle-reports
+          CIRCLE_ARTIFACTS: /tmp/circle-artifacts
+          COMMON_GO_PACKAGES: >
+            github.com/jstemmer/go-junit-report
+
+    working_directory: /go/src/github.com/launchdarkly/go-test-helpers
+
+    steps:
+      - checkout
+      - run: go get -u $COMMON_GO_PACKAGES
+      - when:
+          condition: <<parameters.run-lint>>
+          steps:
+            - run: make lint
+      
+      - run:
+          name: Run tests
+          command: |
+            mkdir -p $CIRCLE_TEST_REPORTS
+            mkdir -p $CIRCLE_ARTIFACTS
+            trap "go-junit-report < $CIRCLE_ARTIFACTS/report.txt > $CIRCLE_TEST_REPORTS/junit.xml" EXIT
+            make test | tee $CIRCLE_ARTIFACTS/report.txt
+
+      - store_test_results:
+          path: /tmp/circle-reports
+
+      - store_artifacts:
+          path: /tmp/circle-artifacts
+
+  go-test-windows:
+    executor:
+      name: win/vs2019
+      shell: powershell.exe
+
+    environment:
+      GOPATH: C:\Users\VssAdministrator\go
+      PACKAGE_PATH: github.com/launchdarkly/go-test-helpers
+
+    steps:
+      - checkout
+      - run: go version
+      - run:
+          name: move source
+          command: |
+            go env GOPATH
+            mkdir ${env:GOPATH}\src\${env:PACKAGE_PATH}
+            mv * ${env:GOPATH}\src\${env:PACKAGE_PATH}
+      - run:
+          name: build and test
+          command: |
+            cd ${env:GOPATH}\src\${env:PACKAGE_PATH}
+            go get -t ./...
+            go test -race ./...

.golangci.yml

@@ -0,0 +1,21 @@
+run:
+  deadline: 120s
+  tests: false
+
+linters:
+  enable-all: true
+  disable:
+    - funlen # allow long/complex functions for now
+    - gocognit # allow long/complex functions for now
+    - gomnd # extremely aggressive linter that complains about all numeric literals, even just adding 1 to something (https://github.com/tommy-muehle/go-mnd)
+    - wsl # enforces a very specific style with an idiosyncratic definition of what "cuddling" is
+  fast: false
+
+linter-settings:
+  gofmt:
+    simplify: false
+
+issues:
+  exclude-use-default: false
+  max-same-issues: 1000
+  max-per-linter: 1000

.ldrelease/config.yml

@@ -0,0 +1,3 @@
+publications:
+  - url: https://godoc.org/github.com/launchdarkly/go-test-helpers
+    description: documentation

.ldrelease/update-version.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+# This script updates the version for the ldclient.go
+
+set -ue
+
+LDCLIENT_GO_TEMP=./ldclient.go.tmp
+sed "s/const Version =.*/const Version = \"${LD_RELEASE_VERSION}\"/g" ldclient.go > ${LDCLIENT_GO_TEMP}
+mv ${LDCLIENT_GO_TEMP} ldclient.go

CHANGELOG.md

@@ -0,0 +1,3 @@
+# Change log
+
+All notable changes to the project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).

CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing to go-test-helpers
+ 
+## Submitting bug reports and feature requests
+
+The LaunchDarkly SDK team maintains this repository and monitors the [issue tracker](https://github.com/launchdarkly/go-test-helpers/issues) there. Bug reports and feature requests specific to this project should be filed in this issue tracker. The team will respond to all newly filed issues within two business days.
+ 
+## Submitting pull requests
+ 
+We encourage pull requests and other contributions from the community. Before submitting pull requests, ensure that all temporary or unintended code is removed. Don't worry about adding reviewers to the pull request; the LaunchDarkly SDK team will add themselves. The SDK team will acknowledge all pull requests within two business days.
+ 
+## Build instructions
+ 
+### Prerequisites
+ 
+This project should be built against Go 1.8 or newer.
+
+### Building
+
+To build the project without running any tests:
+```
+make
+```
+
+If you wish to clean your working directory between builds, you can clean it by running:
+```
+make clean
+```
+
+To run the linter:
+```
+make lint
+```
+
+### Testing
+ 
+To build the project and run all unit tests:
+```
+make test
+```

Makefile

@@ -0,0 +1,28 @@
+
+GOLANGCI_LINT_VERSION=v1.23.7
+
+LINTER=./bin/golangci-lint
+LINTER_VERSION_FILE=./bin/.golangci-lint-version-$(GOLANGCI_LINT_VERSION)
+
+.PHONY: build clean test lint
+
+build:
+	go get ./...
+	go build ./...
+
+clean:
+	go clean
+
+test: build
+	go get -t ./...
+	@# Note, we need to specify all these packages individually for go test in order to remain 1.8-compatible
+	go test -race -v . ./httphelpers ./ldservices
+
+$(LINTER_VERSION_FILE):
+	rm -f $(LINTER)
+	curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | bash -s $(GOLANGCI_LINT_VERSION)
+	touch $(LINTER_VERSION_FILE)
+
+lint: $(LINTER_VERSION_FILE)
+	go get ./...
+	$(LINTER) run ./...

README.md

@@ -0,0 +1,48 @@
+# LaunchDarkly Go Test Helpers
+
+[![Circle CI](https://circleci.com/gh/launchdarkly/go-test-helpers.svg?style=svg)](https://circleci.com/gh/launchdarkly/go-test-helpers)
+
+This package centralizes some test support code that is used by LaunchDarkly's Go SDK and related components, and that may be useful in other Go projects.
+
+While this code may be useful in other projects, it is primarily geared toward LaunchDarkly's own development needs and is not meant to provide a large general-purpose framework. It is meant for unit test code and should not be used as a runtime dependency.
+
+## Contents
+
+The main package provides general-purpose helper functions.
+
+Subpackage `httphelpers` provides convenience wrappers for using `net/http` and `net/http/httptest` in test code.
+
+Subpackage `ldservices` is specifically for testing LaunchDarkly SDK client components; it provides HTTP handlers that simulate the service endpoints used by the SDK.
+
+## Usage
+
+Import any of these packages in your test code:
+
+```go
+import (
+    "github.com/launchdarkly/go-test-helpers"
+    "github.com/launchdarkly/go-test-helpers/httphelpers"
+    "github.com/launchdarkly/go-test-helpers/ldservices"
+)
+```
+
+Breaking changes will only be made in a new major version. It is advisable to use a dependency manager to pin these dependencies to a major version branch (`v1`, etc.).
+
+## Contributing
+
+We encourage pull requests and other contributions from the community. Check out our [contributing guidelines](CONTRIBUTING.md) for instructions on how to contribute to this project.
+
+## About LaunchDarkly
+
+* LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard.  With LaunchDarkly, you can:
+    * Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
+    * Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
+    * Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
+    * Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
+* LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Check out [our documentation](https://docs.launchdarkly.com/docs) for a complete list.
+* Explore LaunchDarkly
+    * [launchdarkly.com](https://www.launchdarkly.com/ "LaunchDarkly Main Website") for more information
+    * [docs.launchdarkly.com](https://docs.launchdarkly.com/  "LaunchDarkly Documentation") for our documentation and SDK reference guides
+    * [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/  "LaunchDarkly API Documentation") for our API documentation
+    * [blog.launchdarkly.com](https://blog.launchdarkly.com/  "LaunchDarkly Blog Documentation") for the latest product updates
+    * [Feature Flagging Guide](https://github.com/launchdarkly/featureflags/  "Feature Flagging Guide") for best practices and strategies

closer.go

@@ -0,0 +1,23 @@
+package helpers
+
+import (
+	"io"
+	"log"
+)
+
+// WithCloser executes a function and ensures that the given object's Close() method is always called afterward.
+//
+// This is simply a way to get more specific control over an object's lifetime than using defer. A test function
+// may wish to ensure that an object is closed before some subsequent actions are taken, rather than at the end
+// of the entire test.
+//
+// If closing the object fails, an error is logged.
+func WithCloser(closeableObject io.Closer, action func()) {
+	defer func() {
+		err := closeableObject.Close()
+		if err != nil {
+			log.Printf("failed to close %T: %s", closeableObject, err)
+		}
+	}()
+	action()
+}

closer_test.go

@@ -0,0 +1,24 @@
+package helpers
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+type myCloser struct {
+	closed bool
+}
+
+func (m *myCloser) Close() error {
+	m.closed = true
+	return nil
+}
+
+func TestWithCloser(t *testing.T) {
+	c := &myCloser{}
+	WithCloser(c, func() {
+		assert.False(t, c.closed)
+	})
+	assert.True(t, c.closed)
+}