From 7ab3e6eb9f5970bc27a884683accb0799280726e Mon Sep 17 00:00:00 2001 From: Dan Kegel Date: Fri, 21 Jan 2022 10:31:20 -0800 Subject: [PATCH] Provide stub so apps using goleak can build unchanged with tinygo. Tinygo can build a large subset of go programs already. Unfortunately, tinygo currently does not quite support goleak. As a temporary measure, use the tinygo build tag to provide a stub for goleak. This will expand the world of go programs that run properly on tinygo, and remove one more obstacle keeping embedded system and wasm users from adopting go and goleak. This can be reverted if/when tinygo is enhanced to fully support goleak. --- leaks.go | 3 +++ leaks_tinygo.go | 41 +++++++++++++++++++++++++++++++++++++++++ testmain.go | 3 +++ 3 files changed, 47 insertions(+) create mode 100644 leaks_tinygo.go diff --git a/leaks.go b/leaks.go index 468dbaf..7b6b588 100644 --- a/leaks.go +++ b/leaks.go @@ -18,6 +18,9 @@ // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN // THE SOFTWARE. +//go:build !tinygo +// +build !tinygo + package goleak import ( diff --git a/leaks_tinygo.go b/leaks_tinygo.go new file mode 100644 index 0000000..9c83d44 --- /dev/null +++ b/leaks_tinygo.go @@ -0,0 +1,41 @@ +// Copyright (c) 2017 Uber Technologies, Inc. + +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in +// all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +// THE SOFTWARE. + +//go:build tinygo +// +build tinygo + +// goleak uses parts of go that are not yet supported by tinygo. +// This file provides a placeholder to allow programs using goleak +// to compile unchanged with tinygo before such support arrives. + +package goleak + +// TestingT is the minimal subset of testing.TB that we use. +type TestingT interface { + Error(...interface{}) +} + +// VerifyNone marks the given TestingT as failed if any extra goroutines are +// found by Find. This is a helper method to make it easier to integrate in +// tests by doing: +// defer VerifyNone(t) +func VerifyNone(t TestingT, options ...Option) { + // Stub until ported to tinygo +} diff --git a/testmain.go b/testmain.go index 316f6e1..d1d96c1 100644 --- a/testmain.go +++ b/testmain.go @@ -18,6 +18,9 @@ // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN // THE SOFTWARE. +//go:build !tinygo +// +build !tinygo + package goleak import (