refactor: replace builtin package with fluxinit/static

adrian-thurston · adrian-thurston · commit dc0ec0d683df · 2020-11-04T19:24:27.000Z
A static initialization is not desirable in the main binaries, as it forces all
paths of code to init, but it is still useful in tests. It allows static
intialization to be performed once for all tests and eliminates the need to
always add the FluxInit call. Added a fluxinit/static package that calls
fluxinit.FluxInit() to replace the builtin package. This hides the nature of
the initialization and makes it clear that it is mandatory initialization code.
diff --git a/builtin/builtin.go b/builtin/builtin.go
diff --git a/examples/library/library_example_test.go b/examples/library/library_example_test.go
@@ -1,7 +1,7 @@
 package library_test
 
 import (
-	_ "github.com/influxdata/flux/builtin"
+	_ "github.com/influxdata/flux/fluxinit/static"
 )
 
 // TODO (faith): https://github.com/influxdata/flux/issues/2476; this is not a test function,
diff --git a/execute/executor_test.go b/execute/executor_test.go
@@ -8,10 +8,10 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/influxdata/flux"
-	_ "github.com/influxdata/flux/builtin"
 	"github.com/influxdata/flux/codes"
 	"github.com/influxdata/flux/execute"
 	"github.com/influxdata/flux/execute/executetest"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/interpreter"
 	"github.com/influxdata/flux/memory"
 	"github.com/influxdata/flux/plan"
diff --git a/fluxinit/init.go b/fluxinit/init.go
@@ -1,18 +1,24 @@
+// Package fluxinit is used to initialize the flux library for compilation and
+// execution of Flux. The FluxInit function should be called exactly once in a
+// process.
 package fluxinit
 
 import (
 	"github.com/influxdata/flux/runtime"
 	_ "github.com/influxdata/flux/stdlib"
 )
 
-// FluxInit() prepares the runtime for compilation and execution of flux. This
-// is a costly step and should only be performed if the intention is to compile
-// and execute flux code.
+// The FluxInit() function prepares the runtime for compilation and execution
+// of Flux. This is a costly step and should only be performed if the intention
+// is to compile and execute flux code.
 //
-// Importing this package and calling FluxInit is equivalent to importing the
-// "builtin" package. It draws in the standard library functions, which
-// register themselves in init() functions, then performs the final steps
-// necessary to prepare for executing flux.
+// This package imports the standard library. These modules register themselves
+// in go init() functions. This package must ensure all required standard
+// library functions are imported.
+//
+// As a convenience, the fluxinit/static package can be imported for use cases
+// where static initialization is okay, such as tests.
+
 func FluxInit() {
 	runtime.FinalizeBuiltIns()
 }
diff --git a/fluxinit/static/static.go b/fluxinit/static/static.go
@@ -0,0 +1,11 @@
+// The fluxinit/static package can be imported in test cases and other uses
+// cases where it is okay to always initialize flux.
+package static
+
+import (
+	"github.com/influxdata/flux/fluxinit"
+)
+
+func init() {
+	fluxinit.FluxInit()
+}
diff --git a/fluxinit/static/static_test.go b/fluxinit/static/static_test.go
@@ -1,9 +1,9 @@
-package builtin_test
+package static_test
 
 import (
 	"testing"
 
-	_ "github.com/influxdata/flux/builtin"
+	_ "github.com/influxdata/flux/fluxinit/static"
 )
 
 func TestBuiltins(t *testing.T) {
diff --git a/internal/cmd/test_rewriter/main.go b/internal/cmd/test_rewriter/main.go
@@ -8,9 +8,9 @@ import (
 
 	"github.com/influxdata/flux"
 	"github.com/influxdata/flux/ast"
-	_ "github.com/influxdata/flux/builtin"
 	"github.com/influxdata/flux/codes"
 	"github.com/influxdata/flux/dependencies/filesystem"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/internal/errors"
 	"github.com/influxdata/flux/lang"
 	"github.com/influxdata/flux/memory"
diff --git a/internal/spec/build_test.go b/internal/spec/build_test.go
@@ -5,8 +5,8 @@ import (
 	"testing"
 	"time"
 
-	_ "github.com/influxdata/flux/builtin"
 	"github.com/influxdata/flux/dependencies/dependenciestest"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/internal/spec"
 	"github.com/influxdata/flux/runtime"
 )
diff --git a/interpreter/package_test.go b/interpreter/package_test.go
@@ -5,9 +5,9 @@ import (
 	"fmt"
 	"testing"
 
-	_ "github.com/influxdata/flux/builtin"
 	"github.com/influxdata/flux/codes"
 	"github.com/influxdata/flux/dependencies/dependenciestest"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/internal/errors"
 	"github.com/influxdata/flux/interpreter"
 	"github.com/influxdata/flux/interpreter/interptest"
diff --git a/lang/compiler_test.go b/lang/compiler_test.go
@@ -12,11 +12,11 @@ import (
 	"github.com/google/go-cmp/cmp"
 	"github.com/influxdata/flux"
 	"github.com/influxdata/flux/ast"
-	_ "github.com/influxdata/flux/builtin"
 	fcsv "github.com/influxdata/flux/csv"
 	"github.com/influxdata/flux/dependencies/dependenciestest"
 	"github.com/influxdata/flux/execute"
 	"github.com/influxdata/flux/execute/executetest"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/lang"
 	"github.com/influxdata/flux/memory"
 	"github.com/influxdata/flux/mock"
diff --git a/lang/query_test.go b/lang/query_test.go
@@ -8,8 +8,8 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/influxdata/flux"
-	_ "github.com/influxdata/flux/builtin"
 	"github.com/influxdata/flux/execute/executetest"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/lang"
 	"github.com/influxdata/flux/memory"
 	"github.com/influxdata/flux/runtime"
diff --git a/plan/builtin_test.go b/plan/builtin_test.go
@@ -1,6 +1,6 @@
 package plan_test
 
 import (
-	// We need to import the builtins for the tests to work.
-	_ "github.com/influxdata/flux/builtin"
+	// We need to init flux for the tests to work.
+	_ "github.com/influxdata/flux/fluxinit/static"
 )
diff --git a/runtime/runtime_test.go b/runtime/runtime_test.go
@@ -6,8 +6,8 @@ import (
 	"os"
 	"testing"
 
-	_ "github.com/influxdata/flux/builtin"
 	"github.com/influxdata/flux/dependencies/dependenciestest"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/interpreter"
 	"github.com/influxdata/flux/parser"
 	"github.com/influxdata/flux/runtime"
diff --git a/stdlib/contrib/chobbs/discord/discord_test.go b/stdlib/contrib/chobbs/discord/discord_test.go
@@ -10,8 +10,8 @@ import (
 	"time"
 
 	"github.com/influxdata/flux"
-	_ "github.com/influxdata/flux/builtin"
 	"github.com/influxdata/flux/dependencies/dependenciestest"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/lang"
 	"github.com/influxdata/flux/memory"
 	"github.com/influxdata/flux/runtime"
diff --git a/stdlib/contrib/sranka/opsgenie/opsgenie_test.go b/stdlib/contrib/sranka/opsgenie/opsgenie_test.go
@@ -12,8 +12,8 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/influxdata/flux"
-	_ "github.com/influxdata/flux/builtin"
 	_ "github.com/influxdata/flux/csv"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/lang"
 	"github.com/influxdata/flux/memory"
 	"github.com/influxdata/flux/runtime"
diff --git a/stdlib/contrib/sranka/sensu/sensu_test.go b/stdlib/contrib/sranka/sensu/sensu_test.go
@@ -13,9 +13,9 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/influxdata/flux"
-	_ "github.com/influxdata/flux/builtin"
 	_ "github.com/influxdata/flux/csv"
 	"github.com/influxdata/flux/dependencies/dependenciestest"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/lang"
 	"github.com/influxdata/flux/memory"
 	"github.com/influxdata/flux/runtime"
diff --git a/stdlib/contrib/sranka/teams/teams_test.go b/stdlib/contrib/sranka/teams/teams_test.go
@@ -11,9 +11,9 @@ import (
 	"time"
 
 	"github.com/influxdata/flux"
-	_ "github.com/influxdata/flux/builtin"
 	_ "github.com/influxdata/flux/csv"
 	"github.com/influxdata/flux/dependencies/dependenciestest"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/lang"
 	"github.com/influxdata/flux/memory"
 	"github.com/influxdata/flux/runtime"
diff --git a/stdlib/contrib/sranka/telegram/telegram_test.go b/stdlib/contrib/sranka/telegram/telegram_test.go
@@ -12,9 +12,9 @@ import (
 	"time"
 
 	"github.com/influxdata/flux"
-	_ "github.com/influxdata/flux/builtin"
 	_ "github.com/influxdata/flux/csv"
 	"github.com/influxdata/flux/dependencies/dependenciestest"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/lang"
 	"github.com/influxdata/flux/memory"
 	"github.com/influxdata/flux/runtime"
diff --git a/stdlib/contrib/tomhollingworth/events/duration_test.go b/stdlib/contrib/tomhollingworth/events/duration_test.go
@@ -5,9 +5,9 @@ import (
 	"time"
 
 	"github.com/influxdata/flux"
-	_ "github.com/influxdata/flux/builtin" // We need to import the builtins for the tests to work.
 	"github.com/influxdata/flux/execute"
 	"github.com/influxdata/flux/execute/executetest"
+	_ "github.com/influxdata/flux/fluxinit/static" // We need to init flux for the tests to work.
 	"github.com/influxdata/flux/querytest"
 	"github.com/influxdata/flux/stdlib/contrib/tomhollingworth/events"
 	"github.com/influxdata/flux/stdlib/influxdata/influxdb"
diff --git a/stdlib/csv/from_test.go b/stdlib/csv/from_test.go
@@ -7,9 +7,9 @@ import (
 	"time"
 
 	"github.com/influxdata/flux"
-	_ "github.com/influxdata/flux/builtin" // We need to import the builtins for the tests to work.
 	"github.com/influxdata/flux/execute"
 	"github.com/influxdata/flux/execute/executetest"
+	_ "github.com/influxdata/flux/fluxinit/static" // We need to init flux for the tests to work.
 	"github.com/influxdata/flux/mock"
 	"github.com/influxdata/flux/querytest"
 	"github.com/influxdata/flux/stdlib/csv"
diff --git a/stdlib/experimental/geo/getgrid_test.go b/stdlib/experimental/geo/getgrid_test.go
@@ -4,7 +4,7 @@ import (
 	"context"
 	"testing"
 
-	_ "github.com/influxdata/flux/builtin"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/querytest"
 	"github.com/influxdata/flux/semantic"
 	"github.com/influxdata/flux/stdlib/experimental/geo"
diff --git a/stdlib/experimental/geo/getlevel_test.go b/stdlib/experimental/geo/getlevel_test.go
@@ -5,7 +5,7 @@ import (
 	"strings"
 	"testing"
 
-	_ "github.com/influxdata/flux/builtin"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/querytest"
 	"github.com/influxdata/flux/stdlib/experimental/geo"
 	"github.com/influxdata/flux/values"
diff --git a/stdlib/experimental/geo/s2CellIDToken_test.go b/stdlib/experimental/geo/s2CellIDToken_test.go
@@ -5,7 +5,7 @@ import (
 	"strings"
 	"testing"
 
-	_ "github.com/influxdata/flux/builtin"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/querytest"
 	"github.com/influxdata/flux/stdlib/experimental/geo"
 	"github.com/influxdata/flux/values"
diff --git a/stdlib/experimental/geo/s2CellLatLon_test.go b/stdlib/experimental/geo/s2CellLatLon_test.go
@@ -6,7 +6,7 @@ import (
 	"strings"
 	"testing"
 
-	_ "github.com/influxdata/flux/builtin"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/querytest"
 	"github.com/influxdata/flux/stdlib/experimental/geo"
 	"github.com/influxdata/flux/values"
diff --git a/stdlib/experimental/geo/stContains_test.go b/stdlib/experimental/geo/stContains_test.go
@@ -4,7 +4,7 @@ import (
 	"context"
 	"testing"
 
-	_ "github.com/influxdata/flux/builtin"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/querytest"
 	"github.com/influxdata/flux/semantic"
 	"github.com/influxdata/flux/stdlib/experimental/geo"
diff --git a/stdlib/experimental/geo/stDistance_test.go b/stdlib/experimental/geo/stDistance_test.go
@@ -5,7 +5,7 @@ import (
 	"math"
 	"testing"
 
-	_ "github.com/influxdata/flux/builtin"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/querytest"
 	"github.com/influxdata/flux/semantic"
 	"github.com/influxdata/flux/stdlib/experimental/geo"
diff --git a/stdlib/experimental/geo/stLength_test.go b/stdlib/experimental/geo/stLength_test.go
@@ -4,7 +4,7 @@ import (
 	"context"
 	"testing"
 
-	_ "github.com/influxdata/flux/builtin"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/querytest"
 	"github.com/influxdata/flux/stdlib/experimental/geo"
 	"github.com/influxdata/flux/values"
diff --git a/stdlib/experimental/group_test.go b/stdlib/experimental/group_test.go
@@ -6,9 +6,9 @@ import (
 	"time"
 
 	"github.com/influxdata/flux"
-	_ "github.com/influxdata/flux/builtin"
 	"github.com/influxdata/flux/execute"
 	"github.com/influxdata/flux/execute/executetest"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/querytest"
 	"github.com/influxdata/flux/stdlib/experimental"
 	"github.com/influxdata/flux/stdlib/influxdata/influxdb"
diff --git a/stdlib/experimental/http/get_test.go b/stdlib/experimental/http/get_test.go
@@ -11,8 +11,8 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/influxdata/flux"
-	_ "github.com/influxdata/flux/builtin"
 	"github.com/influxdata/flux/dependencies/url"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/runtime"
 )
 
diff --git a/stdlib/experimental/mqtt/to_test.go b/stdlib/experimental/mqtt/to_test.go
@@ -7,9 +7,9 @@ import (
 
 	MQTT "github.com/eclipse/paho.mqtt.golang"
 	"github.com/influxdata/flux"
-	_ "github.com/influxdata/flux/builtin" // We need to import the builtins for the tests to work.
 	"github.com/influxdata/flux/execute"
 	"github.com/influxdata/flux/execute/executetest"
+	_ "github.com/influxdata/flux/fluxinit/static" // We need to init flux for the tests to work.
 	"github.com/influxdata/flux/querytest"
 	"github.com/influxdata/flux/stdlib/experimental/mqtt"
 	"github.com/influxdata/flux/stdlib/influxdata/influxdb"
diff --git a/stdlib/generate/from_test.go b/stdlib/generate/from_test.go
@@ -5,8 +5,8 @@ import (
 	"time"
 
 	"github.com/influxdata/flux"
-	_ "github.com/influxdata/flux/builtin"
 	"github.com/influxdata/flux/execute/executetest"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/interpreter"
 	"github.com/influxdata/flux/querytest"
 	"github.com/influxdata/flux/runtime"
diff --git a/stdlib/http/post_test.go b/stdlib/http/post_test.go
@@ -12,8 +12,8 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/influxdata/flux"
-	_ "github.com/influxdata/flux/builtin"
 	"github.com/influxdata/flux/dependencies/url"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/runtime"
 )
 
diff --git a/stdlib/influxdata/influxdb/builtin_test.go b/stdlib/influxdata/influxdb/builtin_test.go
@@ -1,6 +1,6 @@
 package influxdb_test
 
 import (
-	// We need to import the builtins for the tests to work.
-	_ "github.com/influxdata/flux/builtin"
+	// We need to init flux for the tests to work.
+	_ "github.com/influxdata/flux/fluxinit/static"
 )
diff --git a/stdlib/influxdata/influxdb/v1/from_influx_json_test.go b/stdlib/influxdata/influxdb/v1/from_influx_json_test.go
@@ -4,7 +4,7 @@ import (
 	"testing"
 
 	"github.com/influxdata/flux"
-	_ "github.com/influxdata/flux/builtin" // We need to import the builtins for the tests to work.
+	_ "github.com/influxdata/flux/fluxinit/static" // We need to init flux for the tests to work.
 	"github.com/influxdata/flux/querytest"
 	"github.com/influxdata/flux/stdlib/influxdata/influxdb/v1"
 )
diff --git a/stdlib/internal/promql/join_test.go b/stdlib/internal/promql/join_test.go
@@ -8,9 +8,9 @@ import (
 	"github.com/google/go-cmp/cmp"
 
 	"github.com/influxdata/flux"
-	_ "github.com/influxdata/flux/builtin"
 	"github.com/influxdata/flux/execute"
 	"github.com/influxdata/flux/execute/executetest"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/interpreter"
 	"github.com/influxdata/flux/stdlib/experimental"
 	"github.com/influxdata/flux/values"
diff --git a/stdlib/json/encode_test.go b/stdlib/json/encode_test.go
@@ -4,8 +4,8 @@ import (
 	"context"
 	"testing"
 
-	_ "github.com/influxdata/flux/builtin"
 	"github.com/influxdata/flux/dependencies/dependenciestest"
+	_ "github.com/influxdata/flux/fluxinit/static"
 	"github.com/influxdata/flux/runtime"
 )
 
diff --git a/stdlib/kafka/to_test.go b/stdlib/kafka/to_test.go
diff --git a/stdlib/pagerduty/pagerduty_test.go b/stdlib/pagerduty/pagerduty_test.go
diff --git a/stdlib/slack/slack_test.go b/stdlib/slack/slack_test.go
diff --git a/stdlib/socket/from_test.go b/stdlib/socket/from_test.go
diff --git a/stdlib/sql/to_test.go b/stdlib/sql/to_test.go

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`package library_test`
`2`	`2`
`3`	`3`	`import (`
`4`		`- _ "github.com/influxdata/flux/builtin"`
	`4`	`+ _ "github.com/influxdata/flux/fluxinit/static"`
`5`	`5`	`)`
`6`	`6`
`7`	`7`	`// TODO (faith): https://github.com/influxdata/flux/issues/2476; this is not a test function,`