Shim-specific configuration file with suppressions and error translation.

This is more progress in letting other stacks use the test runner.
You can provide a per-shim configuration file that includes:

 - A list of test patterns to be suppressed (presumably because
   they don't work). This setting is ignored if -test is used.
 - A translation table of expected errors to shim-specific errors.

BUG=92

Change-Id: I3c31d136e35c282e05d4919e18ba41d44ea9cf2a
Reviewed-on: https://boringssl-review.googlesource.com/9161
Reviewed-by: David Benjamin <davidben@google.com>
Commit-Queue: David Benjamin <davidben@google.com>
CQ-Verified: CQ bot account: commit-bot@chromium.org <commit-bot@chromium.org>
This commit is contained in:
EKR 2016-08-06 13:25:12 -07:00 committed by CQ bot account: commit-bot@chromium.org
parent 2a389ace62
commit f71d7ed014

View File

@ -20,6 +20,7 @@ import (
"crypto/elliptic" "crypto/elliptic"
"crypto/x509" "crypto/x509"
"encoding/base64" "encoding/base64"
"encoding/json"
"encoding/pem" "encoding/pem"
"errors" "errors"
"flag" "flag"
@ -59,8 +60,28 @@ var (
deterministic = flag.Bool("deterministic", false, "If true, uses a deterministic PRNG in the runner.") deterministic = flag.Bool("deterministic", false, "If true, uses a deterministic PRNG in the runner.")
allowUnimplemented = flag.Bool("allow-unimplemented", false, "If true, report pass even if some tests are unimplemented.") allowUnimplemented = flag.Bool("allow-unimplemented", false, "If true, report pass even if some tests are unimplemented.")
looseErrors = flag.Bool("loose-errors", false, "If true, allow shims to report an untranslated error code.") looseErrors = flag.Bool("loose-errors", false, "If true, allow shims to report an untranslated error code.")
shimConfigFile = flag.String("shim-config", "", "A config file to use to configure the tests for this shim.")
includeDisabled = flag.Bool("include-disabled", false, "If true, also runs disabled tests.")
) )
// ShimConfigurations is used with the “json” package and represents a shim
// config file.
type ShimConfiguration struct {
// DisabledTests maps from a glob-based pattern to a freeform string.
// The glob pattern is used to exclude tests from being run and the
// freeform string is unparsed but expected to explain why the test is
// disabled.
DisabledTests map[string]string
// ErrorMap maps from expected error strings to the correct error
// string for the shim in question. For example, it might map
// “:NO_SHARED_CIPHER:” (a BoringSSL error string) to something
// like “SSL_ERROR_NO_CYPHER_OVERLAP”.
ErrorMap map[string]string
}
var shimConfig ShimConfiguration
type testCert int type testCert int
const ( const (
@ -719,6 +740,18 @@ func acceptOrWait(listener net.Listener, waitChan chan error) (net.Conn, error)
} }
} }
func translateExpectedError(errorStr string) string {
if translated, ok := shimConfig.ErrorMap[errorStr]; ok {
return translated
}
if *looseErrors {
return ""
}
return errorStr
}
func runTest(test *testCase, shimPath string, mallocNumToFail int64) error { func runTest(test *testCase, shimPath string, mallocNumToFail int64) error {
if !test.shouldFail && (len(test.expectedError) > 0 || len(test.expectedLocalError) > 0) { if !test.shouldFail && (len(test.expectedError) > 0 || len(test.expectedLocalError) > 0) {
panic("Error expected without shouldFail in " + test.name) panic("Error expected without shouldFail in " + test.name)
@ -912,8 +945,8 @@ func runTest(test *testCase, shimPath string, mallocNumToFail int64) error {
} }
failed := err != nil || childErr != nil failed := err != nil || childErr != nil
correctFailure := len(test.expectedError) == 0 || strings.Contains(stderr, test.expectedError) || expectedError := translateExpectedError(test.expectedError)
(*looseErrors && strings.Contains(stderr, "UNTRANSLATED_ERROR")) correctFailure := len(expectedError) == 0 || strings.Contains(stderr, expectedError)
localError := "none" localError := "none"
if err != nil { if err != nil {
@ -936,7 +969,7 @@ func runTest(test *testCase, shimPath string, mallocNumToFail int64) error {
case !failed && test.shouldFail: case !failed && test.shouldFail:
msg = "unexpected success" msg = "unexpected success"
case failed && !correctFailure: case failed && !correctFailure:
msg = "bad error (wanted '" + test.expectedError + "' / '" + test.expectedLocalError + "')" msg = "bad error (wanted '" + expectedError + "' / '" + test.expectedLocalError + "')"
default: default:
panic("internal error") panic("internal error")
} }
@ -8003,6 +8036,19 @@ func main() {
testChan := make(chan *testCase, *numWorkers) testChan := make(chan *testCase, *numWorkers)
doneChan := make(chan *testOutput) doneChan := make(chan *testOutput)
if len(*shimConfigFile) != 0 {
encoded, err := ioutil.ReadFile(*shimConfigFile)
if err != nil {
fmt.Fprintf(os.Stderr, "Couldn't read config file %q: %s\n", *shimConfigFile, err)
os.Exit(1)
}
if err := json.Unmarshal(encoded, &shimConfig); err != nil {
fmt.Fprintf(os.Stderr, "Couldn't decode config file %q: %s\n", *shimConfigFile, err)
os.Exit(1)
}
}
go statusPrinter(doneChan, statusChan, len(testCases)) go statusPrinter(doneChan, statusChan, len(testCases))
for i := 0; i < *numWorkers; i++ { for i := 0; i < *numWorkers; i++ {
@ -8022,6 +8068,21 @@ func main() {
} }
} }
if !*includeDisabled {
for pattern := range shimConfig.DisabledTests {
isDisabled, err := filepath.Match(pattern, testCases[i].name)
if err != nil {
fmt.Fprintf(os.Stderr, "Error matching pattern %q from config file: %s\n", pattern, err)
os.Exit(1)
}
if isDisabled {
matched = false
break
}
}
}
if matched { if matched {
foundTest = true foundTest = true
testChan <- &testCases[i] testChan <- &testCases[i]
@ -8029,7 +8090,7 @@ func main() {
} }
if !foundTest { if !foundTest {
fmt.Fprintf(os.Stderr, "No tests matched %q\n", *testToRun) fmt.Fprintf(os.Stderr, "No tests run\n")
os.Exit(1) os.Exit(1)
} }