Categorygithub.com/launchdarkly/go-test-helpers/v2
modulepackage
2.3.2
Repository: https://github.com/launchdarkly/go-test-helpers.git
Documentation: pkg.go.dev
Overview
Versions
3
Dependencies
6
Dependents
0
Files
104 SLOC

# README

LaunchDarkly Go Test Helpers

Circle CI Documentation

This project 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.

This version of the project requires Go 1.13 or higher.

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 jsonhelpers provides functions for manipulating JSON.

Subpackage ldservices is specifically for testing LaunchDarkly SDK client components; it provides HTTP handlers that simulate the service endpoints used by the SDK.

Subpackage matchers contains a test assertion API with combinators.

Subpackage testbox provides the ability to write tests-of-tests within the Go testing framework.

Usage

Import any of these packages in your test code:

import (
    "github.com/launchdarkly/go-test-helpers/v2"
    "github.com/launchdarkly/go-test-helpers/v2/httphelpers"
    "github.com/launchdarkly/go-test-helpers/v2/ldservices"
    "github.com/launchdarkly/go-test-helpers/v2/testbox"
)

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 module version or a major version branch.

Contributing

We encourage pull requests and other contributions from the community. Check out our contributing guidelines 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 for a complete list.
  • Explore LaunchDarkly

# Packages

Package httphelpers contains convenience tools for testing HTTP client code.
Package jsonhelpers contains general-purpose functions for manipulating JSON.
Package ldservices provides HTTP handlers that simulate the behavior of LaunchDarkly service endpoints.
Package matchers provides a flexible test assertion API similar to Java's Hamcrest.
Package testbox provides the ability to run test logic that uses a subset of Go's testing.T methods either inside or outside the regular testing environment.

# Functions

BoolPtr returns a pointer to a bool value.
FilePathExists is simply a shortcut for using os.Stat to check for a file's or directory's existence.
Float64Ptr returns a pointer to an float64 value.
IntPtr returns a pointer to an int value.
ReadWithTimeout reads data until it gets the desired number of bytes or times out.
StrPtr returns a pointer to a string value.
Uint64Ptr returns a pointer to a uint64 value.
WithCloser executes a function and ensures that the given object's Close() method is always called afterward.
WithTempFile creates a temporary file, passes its name to the given function, then ensures that the file is deleted.