merge latest from master to poc branch

.gitignore

@@ -1,4 +1,5 @@
 .glide/
+.vscode/
 bin/
 _vendor-*/
 vendor.orig/

README.md

@@ -6,7 +6,7 @@
 [Open Service Broker](https://www.openservicebrokerapi.org/)-compatible API
 server that provisions managed services in the Microsoft Azure public cloud.
 
-|![](https://upload.wikimedia.org/wikipedia/commons/thumb/1/17/Warning.svg/150px-Warning.svg.png) | This software is under heavy development. Releases observe [semantic versioning](https://semver.org), but the project is in an ALPHA status and no assurances are made regarding backwards compatibility or stability. All releases prior to v1.0.0 will remain subject to the possibility of breaking changes when the MINOR version number has been incremented. |
+|![](https://upload.wikimedia.org/wikipedia/commons/thumb/1/17/Warning.svg/150px-Warning.svg.png) | This software is under heavy development. Releases observe [semantic versioning](https://semver.org), but the project is in an ALPHA status and no assurances are made regarding backwards compatibility or stability. All releases prior to v1.0.0 will remain subject to the possibility of breaking changes when the MINOR version number has been incremented. Please see the offical [roadmap](docs/roadmap.md) for more information. |
 |---|---|
 
 ![Open Service Broker for Azure GIF](docs/images/demovideo.gif)

cmd/broker/broker.go

@@ -10,9 +10,11 @@ import (
 	"syscall"
 	"time"
 
-	"github.com/Azure/open-service-broker-azure/pkg/api/authenticator/basic"
+	apiFilters "github.com/Azure/open-service-broker-azure/pkg/api/filters"
 	"github.com/Azure/open-service-broker-azure/pkg/broker"
 	"github.com/Azure/open-service-broker-azure/pkg/crypto/aes256"
+	"github.com/Azure/open-service-broker-azure/pkg/http/filter"
+	"github.com/Azure/open-service-broker-azure/pkg/http/filters"
 	"github.com/Azure/open-service-broker-azure/pkg/version"
 	log "github.com/Sirupsen/logrus"
 	"github.com/go-redis/redis"
@@ -95,13 +97,17 @@ func main() {
 		log.Fatal(err)
 	}
 
+	// Assemble the filter chain
 	basicAuthConfig, err := getBasicAuthConfig()
 	if err != nil {
 		log.Fatal(err)
 	}
-	authenticator := basic.NewAuthenticator(
-		basicAuthConfig.Username,
-		basicAuthConfig.Password,
+	filterChain := filter.NewChain(
+		filters.NewBasicAuthFilter(
+			basicAuthConfig.Username,
+			basicAuthConfig.Password,
+		),
+		apiFilters.NewAPIVersionFilter(),
 	)
 
 	modulesConfig, err := getModulesConfig()
@@ -119,7 +125,7 @@ func main() {
 		storageRedisClient,
 		asyncRedisClient,
 		codec,
-		authenticator,
+		filterChain,
 		modules,
 		modulesConfig.MinStability,
 		azureConfig.DefaultLocation,

cmd/compliance-test-broker/compliance-test-broker.go

@@ -8,9 +8,11 @@ import (
 	"time"
 
 	"github.com/Azure/open-service-broker-azure/pkg/api"
-	"github.com/Azure/open-service-broker-azure/pkg/api/authenticator/basic"
+	apiFilters "github.com/Azure/open-service-broker-azure/pkg/api/filters"
 	fakeAsync "github.com/Azure/open-service-broker-azure/pkg/async/fake"
 	"github.com/Azure/open-service-broker-azure/pkg/crypto/noop"
+	"github.com/Azure/open-service-broker-azure/pkg/http/filter"
+	"github.com/Azure/open-service-broker-azure/pkg/http/filters"
 	"github.com/Azure/open-service-broker-azure/pkg/services/fake"
 	memoryStorage "github.com/Azure/open-service-broker-azure/pkg/storage/memory"
 	log "github.com/Sirupsen/logrus"
@@ -29,17 +31,17 @@ func main() {
 	username := "username"
 	password := "password"
 
-	authenticator := basic.NewAuthenticator(
-		username,
-		password,
+	filterChain := filter.NewChain(
+		filters.NewBasicAuthFilter(username, password),
+		apiFilters.NewAPIVersionFilter(),
 	)
 
 	noopCodec := noop.NewCodec()
 	server, err := api.NewServer(
 		8080,
 		memoryStorage.NewStore(fakeCatalog, noopCodec),
 		fakeAsync.NewEngine(),
-		authenticator,
+		filterChain,
 		fakeCatalog,
 		" ",
 		" ",

docs/roadmap.md

@@ -0,0 +1,37 @@
+# Roadmap
+
+This is the official roadmap for the Open Service Broker for Azure (OSBA) project. OSBA is currently available as an alpha release and this roadmap represents our plan to deliver (OSBA) and the services it provides in a stable form.
+
+This roadmap addresses stability in terms of two dimensions:
+
+* Services/Plans
+* Database Schemas
+
+These aspects of the broker can mature out of step and need to be considered independently. For example, the broker currently uses Redis to store all data and orchestrate asynchronous queues. As the broker matures, we may make changes that require additional information to be persisted for provisioned services or change table or collection names. These will result in incompatibilities with previously populated Redis instances. As we make these changes to mature the broker and work toward a stable release, we are not able to guarantee backward compatibility or migration paths for previous broker installations. Once we declare services and our broker have reached preview status, we will begin to ensure backward compatibility for future releases.
+
+See below for more information concerning stability plans for each.
+
+# Services and Plans
+
+As services are developed, the plans available and features of the service may change and are not guaranteed to exist in the final stable release. When a service is promoted to stable, we will ensure backward compatibility. Services/Plans have three stability tiers:
+
+- `experimental` - We have an idea for a new service that we want to support, but don't have a good idea how it should look. We are essentially “throwing something against the wall” to see if it'll stick. Experimental services may be radically changed or removed at any time
+- `preview` - We have a better understanding how a service should look, but we don't yet guarantee backward compatibility. We do guarantee that this service won't go back to `experimental`, so we are committing to making it exist in some shape or form
+- `stable` - We now understand usage patterns of the service very well and we guarantee full backward compatibility
+
+Here are our timelines for service stabilities:
+
+- SQL Server: `preview` by the end of February 2018
+- MySQL: `preview` by the end of February 2018
+- PostgreSQL: `preview` by the end of February 2018
+
+We aren't yet setting timelines on other service stabilities, but will continue to mature additional services once we promote the service modules above to preview. Promotion from preview to stable will depend on the maturity of the underlying service. For example, the [Azure Database for PostgreSQL](https://azure.microsoft.com/en-us/services/postgresql/) service offering is currently in `Preview`. We will not promote the OSBA PostgreSQL offering to `stable` until the service itself is promoted out of `Preview` status.
+
+# Database Schemas
+
+There are two tiers of database schemas to consider:
+
+1. General outline: the broker currently uses Redis to store all data and orchestrate asynchronous queues. General outline means the names and arrangement of the "tables" and layout of asynchronous queues
+1. Individual services: the broker stores provisioning and binding data for each service/plan in a "table" in Redis. Individual services means the layout of each provisioning & binding record. When a service is marked `stable`, its individual service schema will be backward compatible.
+
+In both areas, maturation of the broker may result in changes to the schema that will be incompatible with previous broker and Redis deployments. Our goal is to have a few services into `preview` before we declare the General outline (#1 above) as backward compatible. Since we're declaring three of them (see above) in `preview` at the end of February 2018, *we are aiming at Mid-march 2018 for a stable general database schema (#1 above)*.

pkg/api/bind.go

@@ -100,21 +100,7 @@ func (s *server) bind(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	// At this point, there's absolute agreement on what service we're dealing
-	// with. We can go ahead and find the Service itself to get the
-	// ServiceManager.
-	svc, ok := s.catalog.GetService(instance.ServiceID)
-	if !ok {
-		// If we don't find the Service in the catalog, something is really wrong.
-		// (It should exist, because an instance with this serviceID exists.)
-		logFields["serviceID"] = instance.ServiceID
-		log.WithFields(logFields).Error(
-			"pre-binding error: no Service found for serviceID",
-		)
-		s.writeResponse(w, http.StatusInternalServerError, responseEmptyJSON)
-		return
-	}
-	serviceManager := svc.GetServiceManager()
+	serviceManager := instance.Service.GetServiceManager()
 
 	// Unpack the parameter map in the request to a struct
 	bindingParameters := serviceManager.GetEmptyBindingParameters()

pkg/api/bind_test.go

@@ -31,11 +31,10 @@ func TestBindingWithInstanceThatIsNotFullyProvisioned(t *testing.T) {
 	s, _, err := getTestServer("", "")
 	assert.Nil(t, err)
 	instanceID := getDisposableInstanceID()
-	planID := getDisposablePlanID()
 	err = s.store.WriteInstance(service.Instance{
 		InstanceID: instanceID,
 		ServiceID:  fake.ServiceID,
-		PlanID:     planID,
+		PlanID:     fake.StandardPlanID,
 		Status:     service.InstanceStateProvisioning,
 	})
 	assert.Nil(t, err)

pkg/api/common_test.go

@@ -3,9 +3,9 @@ package api
 import (
 	"fmt"
 
-	"github.com/Azure/open-service-broker-azure/pkg/api/authenticator/always"
 	fakeAsync "github.com/Azure/open-service-broker-azure/pkg/async/fake"
 	"github.com/Azure/open-service-broker-azure/pkg/crypto/noop"
+	"github.com/Azure/open-service-broker-azure/pkg/http/filter"
 	"github.com/Azure/open-service-broker-azure/pkg/services/fake"
 	memoryStorage "github.com/Azure/open-service-broker-azure/pkg/storage/memory"
 	uuid "github.com/satori/go.uuid"
@@ -60,7 +60,7 @@ func getTestServer(
 		8080,
 		memoryStorage.NewStore(fakeCatalog, noop.NewCodec()),
 		fakeAsync.NewEngine(),
-		always.NewAuthenticator(),
+		filter.NewChain(),
 		fakeCatalog,
 		defaultAzureLocation,
 		defaultAzureResourceGroup,

pkg/api/deprovision.go

@@ -5,7 +5,7 @@ import (
 	"strconv"
 	"time"
 
-	"github.com/Azure/open-service-broker-azure/pkg/async/model"
+	"github.com/Azure/open-service-broker-azure/pkg/async"
 	"github.com/Azure/open-service-broker-azure/pkg/service"
 	log "github.com/Sirupsen/logrus"
 	"github.com/gorilla/mux"
@@ -84,32 +84,9 @@ func (s *server) deprovision(w http.ResponseWriter, r *http.Request) {
 	// or has failed provisioning. We need to kick off asynchronous
 	// deprovisioning.
 
-	svc, ok := s.catalog.GetService(instance.ServiceID)
-	if !ok {
-		// If we don't find the Service in the catalog, something is really wrong.
-		// (It should exist, because an instance with this serviceID exists.)
-		logFields["serviceID"] = instance.ServiceID
-		log.WithFields(logFields).Error(
-			"pre-deprovisioning error: no Service found for serviceID",
-		)
-		s.writeResponse(w, http.StatusInternalServerError, responseEmptyJSON)
-		return
-	}
-	plan, ok := svc.GetPlan(instance.PlanID)
-	if !ok {
-		// If we don't find the Service in the catalog, something is really wrong.
-		// (It should exist, because an instance with this serviceID exists.)
-		logFields["serviceID"] = instance.ServiceID
-		logFields["planID"] = instance.PlanID
-		log.WithFields(logFields).Error(
-			"pre-deprovisioning error: no Plan found for planID in Service",
-		)
-		s.writeResponse(w, http.StatusInternalServerError, responseEmptyJSON)
-		return
-	}
-	serviceManager := svc.GetServiceManager()
+	serviceManager := instance.Service.GetServiceManager()
 
-	deprovisioner, err := serviceManager.GetDeprovisioner(plan)
+	deprovisioner, err := serviceManager.GetDeprovisioner(instance.Plan)
 	if err != nil {
 		logFields["serviceID"] = instance.ServiceID
 		logFields["planID"] = instance.PlanID
@@ -153,10 +130,10 @@ func (s *server) deprovision(w http.ResponseWriter, r *http.Request) {
 		s.writeResponse(w, http.StatusInternalServerError, responseEmptyJSON)
 	}
 
-	var task model.Task
+	var task async.Task
 	if childCount > 0 {
 		logFields["provisionedChildren"] = childCount
-		task = model.NewDelayedTask(
+		task = async.NewDelayedTask(
 			"checkChildrenStatuses",
 			map[string]string{
 				"instanceID": instanceID,
@@ -165,8 +142,8 @@ func (s *server) deprovision(w http.ResponseWriter, r *http.Request) {
 		)
 		log.WithFields(logFields).Debug("children not deprovisioned, waiting")
 	} else {
-		task = model.NewTask(
-			"deprovisionStep",
+		task = async.NewTask(
+			"executeDeprovisioningStep",
 			map[string]string{
 				"stepName":   firstStepName,
 				"instanceID": instanceID,