internal/contour: Refactor v2 contour files into v2 package

Refactors the contour package into a v2 package for Envoy API V2 types. Common items are kept in the contour package for use by other versions. This doesn't change anything functionally, just refactors contour into a v2 package. Updates: projectcontour#1898 Signed-off-by: Steve Sloka <slokas@vmware.com>
stevesloka · Sep 21, 2020 · bd45169 · bd45169
1 parent aae453f
commit bd45169
Show file tree

Hide file tree

Showing 25 changed files with 291 additions and 282 deletions.
diff --git a/cmd/contour/serve.go b/cmd/contour/serve.go
@@ -28,6 +28,7 @@ import (
 	"github.com/envoyproxy/go-control-plane/pkg/server/v2"
 	"github.com/projectcontour/contour/internal/annotation"
 	"github.com/projectcontour/contour/internal/contour"
+	v2 "github.com/projectcontour/contour/internal/contour/v2"
 	"github.com/projectcontour/contour/internal/dag"
 	"github.com/projectcontour/contour/internal/debug"
 	"github.com/projectcontour/contour/internal/health"
@@ -201,7 +202,7 @@ func doServe(log logrus.FieldLogger, ctx *serveContext) error {
 		return fmt.Errorf("error parsing request timeout: %w", err)
 	}
 
-	listenerConfig := contour.ListenerConfig{
+	listenerConfig := v2.ListenerConfig{
 		UseProxyProto:                 ctx.useProxyProto,
 		HTTPAddress:                   ctx.httpAddr,
 		HTTPPort:                      ctx.httpPort,
@@ -230,13 +231,13 @@ func doServe(log logrus.FieldLogger, ctx *serveContext) error {
 
 	// Endpoints updates are handled directly by the EndpointsTranslator
 	// due to their high update rate and their orthogonal nature.
-	endpointHandler := contour.NewEndpointsTranslator(log.WithField("context", "endpointstranslator"))
+	endpointHandler := v2.NewEndpointsTranslator(log.WithField("context", "endpointstranslator"))
 
 	resources := []contour.ResourceCache{
-		contour.NewListenerCache(listenerConfig, ctx.statsAddr, ctx.statsPort),
-		&contour.SecretCache{},
-		&contour.RouteCache{},
-		&contour.ClusterCache{},
+		v2.NewListenerCache(listenerConfig, ctx.statsAddr, ctx.statsPort),
+		&v2.SecretCache{},
+		&v2.RouteCache{},
+		&v2.ClusterCache{},
 		endpointHandler,
 	}
 

diff --git a/cmd/contour/servecontext.go b/cmd/contour/servecontext.go
@@ -25,7 +25,8 @@ import (
 	"strings"
 	"time"
 
-	"github.com/projectcontour/contour/internal/contour"
+	v2 "github.com/projectcontour/contour/internal/contour/v2"
+
 	"github.com/projectcontour/contour/internal/envoy"
 	"github.com/sirupsen/logrus"
 	"google.golang.org/grpc"
@@ -162,8 +163,8 @@ func newServeContext() *serveContext {
 		healthPort:            8000,
 		metricsAddr:           "0.0.0.0",
 		metricsPort:           8000,
-		httpAccessLog:         contour.DEFAULT_HTTP_ACCESS_LOG,
-		httpsAccessLog:        contour.DEFAULT_HTTPS_ACCESS_LOG,
+		httpAccessLog:         v2.DEFAULT_HTTP_ACCESS_LOG,
+		httpsAccessLog:        v2.DEFAULT_HTTPS_ACCESS_LOG,
 		httpAddr:              "0.0.0.0",
 		httpsAddr:             "0.0.0.0",
 		httpPort:              8080,

diff --git a/cmd/contour/shutdownmanager.go b/cmd/contour/shutdownmanager.go
@@ -21,7 +21,7 @@ import (
 	"os"
 	"time"
 
-	"github.com/projectcontour/contour/internal/contour"
+	v2 "github.com/projectcontour/contour/internal/contour/v2"
 
 	"github.com/prometheus/common/expfmt"
 
@@ -43,7 +43,7 @@ const shutdownReadyFile = "/ok"
 const shutdownReadyCheckInterval = time.Second * 1
 
 func prometheusLabels() []string {
-	return []string{contour.ENVOY_HTTP_LISTENER, contour.ENVOY_HTTPS_LISTENER}
+	return []string{v2.ENVOY_HTTP_LISTENER, v2.ENVOY_HTTPS_LISTENER}
 }
 
 type shutdownmanagerContext struct {

diff --git a/internal/contour/cond_test.go b/internal/contour/cond_test.go
@@ -13,7 +13,9 @@
 
 package contour
 
-import "testing"
+import (
+	"testing"
+)
 
 func TestCondRegisterBeforeNotifyShouldNotBroadcast(t *testing.T) {
 	var c Cond

diff --git a/internal/contour/example_test.go b/internal/contour/example_test.go
@@ -11,22 +11,20 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package contour_test
+package contour
 
 import (
 	"context"
 	"fmt"
 	"time"
-
-	"github.com/projectcontour/contour/internal/contour"
 )
 
 func ExampleCond() {
 	ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
 	defer cancel()
 	ch := make(chan int, 1)
 	last := 0
-	var c contour.Cond
+	var c Cond
 	go func() {
 		for {
 			time.Sleep(100 * time.Millisecond)

diff --git a/internal/contour/snapshot.go b/internal/contour/snapshot.go
@@ -18,12 +18,11 @@ import (
 	"reflect"
 	"strconv"
 
-	"github.com/projectcontour/contour/internal/xds"
-
 	envoy_xds "github.com/envoyproxy/go-control-plane/pkg/cache/types"
 	"github.com/envoyproxy/go-control-plane/pkg/cache/v2"
 	resource "github.com/envoyproxy/go-control-plane/pkg/resource/v2"
 	"github.com/projectcontour/contour/internal/dag"
+	"github.com/projectcontour/contour/internal/xds"
 	"github.com/sirupsen/logrus"
 )
 

diff --git a/internal/contour/cluster.go → internal/contour/v2/cluster.go b/internal/contour/cluster.go → internal/contour/v2/cluster.go
@@ -11,12 +11,14 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package contour
+package v2
 
 import (
 	"sort"
 	"sync"
 
+	"github.com/projectcontour/contour/internal/contour"
+
 	envoy_api_v2 "github.com/envoyproxy/go-control-plane/envoy/api/v2"
 	resource "github.com/envoyproxy/go-control-plane/pkg/resource/v2"
 	"github.com/golang/protobuf/proto"
@@ -31,7 +33,7 @@ import (
 type ClusterCache struct {
 	mu     sync.Mutex
 	values map[string]*envoy_api_v2.Cluster
-	Cond
+	contour.Cond
 }
 
 // Update replaces the contents of the cache with the supplied map.

diff --git a/internal/contour/cluster_test.go → internal/contour/v2/cluster_test.go b/internal/contour/cluster_test.go → internal/contour/v2/cluster_test.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package contour
+package v2
 
 import (
 	"testing"

diff --git a/internal/contour/contour_test.go → internal/contour/v2/contour_test.go b/internal/contour/contour_test.go → internal/contour/v2/contour_test.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package contour
+package v2
 
 import (
 	v1 "k8s.io/api/core/v1"

diff --git a/internal/contour/endpointstranslator.go → internal/contour/v2/endpointstranslator.go b/internal/contour/endpointstranslator.go → internal/contour/v2/endpointstranslator.go
@@ -11,13 +11,15 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package contour
+package v2
 
 import (
 	"fmt"
 	"sort"
 	"sync"
 
+	"github.com/projectcontour/contour/internal/contour"
+
 	envoy_api_v2 "github.com/envoyproxy/go-control-plane/envoy/api/v2"
 	envoy_api_v2_endpoint "github.com/envoyproxy/go-control-plane/envoy/api/v2/endpoint"
 	resource "github.com/envoyproxy/go-control-plane/pkg/resource/v2"
@@ -222,7 +224,7 @@ func (c *EndpointsCache) DeleteEndpoint(ep *v1.Endpoints) {
 // NewEndpointsTranslator allocates a new endpoints translator.
 func NewEndpointsTranslator(log logrus.FieldLogger) *EndpointsTranslator {
 	return &EndpointsTranslator{
-		Cond:        Cond{},
+		Cond:        contour.Cond{},
 		FieldLogger: log,
 		entries:     map[string]*envoy_api_v2.ClusterLoadAssignment{},
 		cache: EndpointsCache{
@@ -237,9 +239,9 @@ func NewEndpointsTranslator(log logrus.FieldLogger) *EndpointsTranslator {
 // ClusterLoadAssignment resources.
 type EndpointsTranslator struct {
 	// Observer notifies when the endpoints cache has been updated.
-	Observer Observer
+	Observer contour.Observer
 
-	Cond
+	contour.Cond
 	logrus.FieldLogger
 
 	cache EndpointsCache

diff --git a/internal/contour/endpointstranslator_test.go → ...al/contour/v2/endpointstranslator_test.go b/internal/contour/endpointstranslator_test.go → ...al/contour/v2/endpointstranslator_test.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package contour
+package v2
 
 import (
 	"testing"

diff --git a/internal/contour/listener.go → internal/contour/v2/listener.go b/internal/contour/listener.go → internal/contour/v2/listener.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package contour
+package v2
 
 import (
 	"path"
@@ -25,6 +25,7 @@ import (
 	http "github.com/envoyproxy/go-control-plane/envoy/config/filter/network/http_connection_manager/v2"
 	resource "github.com/envoyproxy/go-control-plane/pkg/resource/v2"
 	"github.com/golang/protobuf/proto"
+	"github.com/projectcontour/contour/internal/contour"
 	"github.com/projectcontour/contour/internal/dag"
 	"github.com/projectcontour/contour/internal/envoy"
 	v2 "github.com/projectcontour/contour/internal/envoy/v2"
@@ -222,7 +223,7 @@ type ListenerCache struct {
 	staticValues map[string]*envoy_api_v2.Listener
 
 	Config ListenerConfig
-	Cond
+	contour.Cond
 }
 
 // NewListenerCache returns an instance of a ListenerCache

diff --git a/internal/contour/listener_test.go → internal/contour/v2/listener_test.go b/internal/contour/listener_test.go → internal/contour/v2/listener_test.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package contour
+package v2
 
 import (
 	"path"

diff --git a/internal/contour/route.go → internal/contour/v2/route.go b/internal/contour/route.go → internal/contour/v2/route.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package contour
+package v2
 
 import (
 	"path"
@@ -23,6 +23,7 @@ import (
 	resource "github.com/envoyproxy/go-control-plane/pkg/resource/v2"
 	"github.com/golang/protobuf/proto"
 	"github.com/golang/protobuf/ptypes/any"
+	"github.com/projectcontour/contour/internal/contour"
 	"github.com/projectcontour/contour/internal/dag"
 	v2 "github.com/projectcontour/contour/internal/envoy/v2"
 	"github.com/projectcontour/contour/internal/protobuf"
@@ -33,7 +34,7 @@ import (
 type RouteCache struct {
 	mu     sync.Mutex
 	values map[string]*envoy_api_v2.RouteConfiguration
-	Cond
+	contour.Cond
 }
 
 // Update replaces the contents of the cache with the supplied map.

diff --git a/internal/contour/route_test.go → internal/contour/v2/route_test.go b/internal/contour/route_test.go → internal/contour/v2/route_test.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package contour
+package v2
 
 import (
 	"testing"

diff --git a/internal/contour/secret.go → internal/contour/v2/secret.go b/internal/contour/secret.go → internal/contour/v2/secret.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package contour
+package v2
 
 import (
 	"sort"
@@ -20,6 +20,7 @@ import (
 	envoy_api_v2_auth "github.com/envoyproxy/go-control-plane/envoy/api/v2/auth"
 	resource "github.com/envoyproxy/go-control-plane/pkg/resource/v2"
 	"github.com/golang/protobuf/proto"
+	"github.com/projectcontour/contour/internal/contour"
 	"github.com/projectcontour/contour/internal/dag"
 	"github.com/projectcontour/contour/internal/envoy"
 	v2 "github.com/projectcontour/contour/internal/envoy/v2"
@@ -31,7 +32,7 @@ import (
 type SecretCache struct {
 	mu     sync.Mutex
 	values map[string]*envoy_api_v2_auth.Secret
-	Cond
+	contour.Cond
 }
 
 // Update replaces the contents of the cache with the supplied map.

diff --git a/internal/contour/secret_test.go → internal/contour/v2/secret_test.go b/internal/contour/secret_test.go → internal/contour/v2/secret_test.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package contour
+package v2
 
 import (
 	"testing"

diff --git a/internal/contour/server_test.go → internal/contour/v2/server_test.go b/internal/contour/server_test.go → internal/contour/v2/server_test.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package contour
+package v2
 
 import (
 	"context"
@@ -20,6 +20,8 @@ import (
 	"testing"
 	"time"
 
+	"github.com/projectcontour/contour/internal/contour"
+
 	v2 "github.com/envoyproxy/go-control-plane/envoy/api/v2"
 	discovery "github.com/envoyproxy/go-control-plane/envoy/service/discovery/v2"
 	resource "github.com/envoyproxy/go-control-plane/pkg/resource/v2"
@@ -40,7 +42,7 @@ import (
 func TestGRPC(t *testing.T) {
 	// tr and et is recreated before the start of each test.
 	var et *EndpointsTranslator
-	var eh *EventHandler
+	var eh *contour.EventHandler
 
 	tests := map[string]func(*testing.T, *grpc.ClientConn){
 		"StreamClusters": func(t *testing.T, cc *grpc.ClientConn) {
@@ -191,20 +193,20 @@ func TestGRPC(t *testing.T) {
 		t.Run(name, func(t *testing.T) {
 			et = NewEndpointsTranslator(fixture.NewTestLogger(t))
 
-			resources := []ResourceCache{
+			resources := []contour.ResourceCache{
 				NewListenerCache(ListenerConfig{}, "", 0),
 				&SecretCache{},
 				&RouteCache{},
 				&ClusterCache{},
 				et,
 			}
 
-			eh = &EventHandler{
-				Observer:    dag.ComposeObservers(ObserversOf(resources)...),
+			eh = &contour.EventHandler{
+				Observer:    dag.ComposeObservers(contour.ObserversOf(resources)...),
 				FieldLogger: log,
 			}
 
-			srv := xds.RegisterServer(xds.NewContourServer(log, ResourcesOf(resources)...), nil)
+			srv := xds.RegisterServer(xds.NewContourServer(log, contour.ResourcesOf(resources)...), nil)
 			l, err := net.Listen("tcp", "127.0.0.1:0")
 			require.NoError(t, err)
 			done := make(chan error, 1)

diff --git a/internal/contour/visitor_test.go → internal/contour/v2/visitor_test.go b/internal/contour/visitor_test.go → internal/contour/v2/visitor_test.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package contour
+package v2
 
 import (
 	"testing"