mirror of
https://github.com/tailscale/tailscale.git
synced 2026-02-10 10:12:27 +01:00
3ec5be3f51
This file was never truly necessary and has never actually been used in the history of Tailscale's open source releases. A Brief History of AUTHORS files --- The AUTHORS file was a pattern developed at Google, originally for Chromium, then adopted by Go and a bunch of other projects. The problem was that Chromium originally had a copyright line only recognizing Google as the copyright holder. Because Google (and most open source projects) do not require copyright assignemnt for contributions, each contributor maintains their copyright. Some large corporate contributors then tried to add their own name to the copyright line in the LICENSE file or in file headers. This quickly becomes unwieldy, and puts a tremendous burden on anyone building on top of Chromium, since the license requires that they keep all copyright lines intact. The compromise was to create an AUTHORS file that would list all of the copyright holders. The LICENSE file and source file headers would then include that list by reference, listing the copyright holder as "The Chromium Authors". This also become cumbersome to simply keep the file up to date with a high rate of new contributors. Plus it's not always obvious who the copyright holder is. Sometimes it is the individual making the contribution, but many times it may be their employer. There is no way for the proejct maintainer to know. Eventually, Google changed their policy to no longer recommend trying to keep the AUTHORS file up to date proactively, and instead to only add to it when requested: https://opensource.google/docs/releasing/authors. They are also clear that: > Adding contributors to the AUTHORS file is entirely within the > project's discretion and has no implications for copyright ownership. It was primarily added to appease a small number of large contributors that insisted that they be recognized as copyright holders (which was entirely their right to do). But it's not truly necessary, and not even the most accurate way of identifying contributors and/or copyright holders. In practice, we've never added anyone to our AUTHORS file. It only lists Tailscale, so it's not really serving any purpose. It also causes confusion because Tailscalars put the "Tailscale Inc & AUTHORS" header in other open source repos which don't actually have an AUTHORS file, so it's ambiguous what that means. Instead, we just acknowledge that the contributors to Tailscale (whoever they are) are copyright holders for their individual contributions. We also have the benefit of using the DCO (developercertificate.org) which provides some additional certification of their right to make the contribution. The source file changes were purely mechanical with: git ls-files | xargs sed -i -e 's/\(Tailscale Inc &\) AUTHORS/\1 contributors/g' Updates #cleanup Change-Id: Ia101a4a3005adb9118051b3416f5a64a4a45987d Signed-off-by: Will Norris <will@tailscale.com>
60 lines
2.3 KiB
Go
60 lines
2.3 KiB
Go
// Copyright (c) Tailscale Inc & contributors
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
// Package eventbustest provides helper methods for testing an [eventbus.Bus].
|
|
//
|
|
// # Usage
|
|
//
|
|
// A [Watcher] presents a set of generic helpers for testing events.
|
|
//
|
|
// To test code that generates events, create a [Watcher] from the [eventbus.Bus]
|
|
// used by the code under test, run the code to generate events, then use the watcher
|
|
// to verify that the expected events were produced. In outline:
|
|
//
|
|
// bus := eventbustest.NewBus(t)
|
|
// tw := eventbustest.NewWatcher(t, bus)
|
|
// somethingThatEmitsSomeEvent()
|
|
// if err := eventbustest.Expect(tw, eventbustest.Type[EventFoo]()); err != nil {
|
|
// t.Error(err.Error())
|
|
// }
|
|
//
|
|
// As shown, [Expect] checks that at least one event of the given type occurs
|
|
// in the stream generated by the code under test.
|
|
//
|
|
// The following functions all take an any parameter representing a function.
|
|
// This function will take an argument of the expected type and is used to test
|
|
// for the events on the eventbus being of the given type. The function can
|
|
// take the shape described in [Expect].
|
|
//
|
|
// [Type] is a helper for only testing event type.
|
|
//
|
|
// To check for specific properties of an event, use [Expect], and pass a function
|
|
// as the second argument that tests for those properties.
|
|
//
|
|
// To test for multiple events, use [Expect], which checks that the stream
|
|
// contains the given events in the given order, possibly with other events
|
|
// interspersed.
|
|
//
|
|
// To test the complete contents of the stream, use [ExpectExactly], which
|
|
// checks that the stream contains exactly the given events in the given order,
|
|
// and no others.
|
|
//
|
|
// To test for the absence of events, use [ExpectExactly] without any
|
|
// expected events, along side [testing/synctest] to avoid waiting for timers
|
|
// to ensure that no events are produced. This will look like:
|
|
//
|
|
// synctest.Test(t, func(t *testing.T) {
|
|
// bus := eventbustest.NewBus(t)
|
|
// tw := eventbustest.NewWatcher(t, bus)
|
|
// somethingThatShouldNotEmitsSomeEvent()
|
|
// synctest.Wait()
|
|
// if err := eventbustest.ExpectExactly(tw); err != nil {
|
|
// t.Errorf("Expected no events or errors, got %v", err)
|
|
// }
|
|
// })
|
|
//
|
|
// See the [usage examples].
|
|
//
|
|
// [usage examples]: https://github.com/tailscale/tailscale/blob/main/util/eventbus/eventbustest/examples_test.go
|
|
package eventbustest
|