README
¶
Testdeck
Testdeck is a framework for integration, end-to-end (E2E), and security testing of gRPC microservices written in Golang.
Please see the docs folder for documentation and tutorials.
Features
- Integration/E2E testing for gRPC microservices written in Golang
- Fuzz testing of gRPC endpoints (using google/gofuzz)
- Injection of malicious payloads (from swisskyrepo/PayloadsAllTheThings), similar to Burpsuite's Intruder function
- Utility methods for gRPC/HTTP requests
- Connecting a debugging proxy such as Charles or Burpsuite to analyze, modify, replay, etc. requests
How to Use
As with all test automation frameworks, you will most likely need to do some customization and fine-tuning to tailor this tool for your organization. It is recommended that you clone this repository and build on top of it to suit your needs.
To learn how to build your own test automation system using Testdeck, please see the setup guide and the blog article.
Contribution
Please read the CLA carefully before submitting your contribution to Mercari. Under any circumstances, by submitting your contribution, you are deemed to accept and agree to be bound by the terms and conditions of the CLA.
License
Copyright 2020 Mercari, Inc.
Licensed under the MIT License.
Documentation
¶
Index ¶
- type TD
- func (c *TD) Error(args ...interface{})
- func (c *TD) Errorf(format string, args ...interface{})
- func (c *TD) Fail()
- func (c *TD) FailNow()
- func (c *TD) Failed() bool
- func (c *TD) Fatal(args ...interface{})
- func (c *TD) Fatalf(format string, args ...interface{})
- func (c *TD) Helper()
- func (c *TD) Log(args ...interface{})
- func (c *TD) Logf(format string, args ...interface{})
- func (c *TD) Name() string
- func (c *TD) Parallel()
- func (c *TD) Skip(args ...interface{})
- func (c *TD) SkipNow()
- func (c *TD) Skipf(format string, args ...interface{})
- func (c *TD) Skipped() bool
- type TestCase
- type TestCaseDelegate
- type TestConfig
- type TestingT
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type TD ¶
type TD struct {
T TestingT // wrapper on testing.T
// contains filtered or unexported fields
}
TD contains a testdeck test case + statistics to save to the DB later It allows us to capture functionality from testing.T
func Test ¶
func Test(t TestingT, tc TestCaseDelegate, options ...TestConfig) *TD
This method starts the test t is the interface for testing.T tc is the interface for testdeck test cases options is an optional parameter for passing in special test configurations
type TestCase ¶
type TestCase struct {
Arrange func(t *TD) // setup stage before the test
Act func(t *TD) // the code you actually want to test
Assert func(t *TD) // the outcomes you want to verify
After func(t *TD) // clean-up steps
deferrer.DefaultDeferrer // deferred steps that you want to run after clean-up
}
A struct that represents a testdeck test case
func (*TestCase) AfterMethod ¶
func (*TestCase) AssertMethod ¶
type TestCaseDelegate ¶
type TestCaseDelegate interface {
ArrangeMethod(t *TD)
ActMethod(t *TD)
AssertMethod(t *TD)
AfterMethod(t *TD)
}
An interface for testdeck test cases; it is implemented by the TestCase struct below
type TestConfig ¶
type TestConfig struct {
// tests run in parallel by default but you can force it to run in sequential by using ParallelOff = true
ParallelOff bool
}
TestConfig is for passing special configurations for the test case
type TestingT ¶
type TestingT interface {
Error(args ...interface{})
Errorf(format string, args ...interface{})
Fail()
FailNow()
Failed() bool
Fatal(args ...interface{})
Fatalf(format string, args ...interface{})
Log(args ...interface{})
Logf(format string, args ...interface{})
Name() string
Skip(args ...interface{})
SkipNow()
Skipf(format string, args ...interface{})
Skipped() bool
Helper()
Parallel()
}
methods from testing.T
Source Files
Directories