Merge pull request #60 from Azure/mgmt-opts

move to mgmt options

Gopkg.toml

@@ -8,7 +8,7 @@
 
 [[constraint]]
     name = "github.com/Azure/azure-amqp-common-go"
-    version = "0.7"
+    version = "1.0.1"
 
 [[constraint]]
     name = "github.com/Azure/azure-storage-blob-go"

changelog.md

@@ -1,8 +1,11 @@
 # Change Log
 
 ## `head`
+
+## `v1.0.0`
 - change from OpenTracing to OpenCensus
 - add more documentation for EPH
+- variadic mgmt options
 
 ## `v0.4.0`
 - add partition key to received event [#43](https://github.com/Azure/azure-event-hubs-go/pull/43)

hub.go

@@ -51,7 +51,7 @@ const (
 	rootUserAgent   = "/golang-event-hubs"
 
 	// Version is the semantic version number
-	Version = "0.4.0"
+	Version = "1.0.0"
 )
 
 type (
@@ -88,7 +88,8 @@ type (
 		GetPartitionInformation(context.Context, string) (HubPartitionRuntimeInformation, error)
 	}
 
-	// HubOption provides structure for configuring new Event Hub instances
+	// HubOption provides structure for configuring new Event Hub clients. For building new Event Hubs, see
+	// HubManagementOption.
 	HubOption func(h *Hub) error
 
 	// HubManager provides CRUD functionality for Event Hubs
@@ -134,6 +135,9 @@ type (
 		EntityAvailabilityStatus *string                `xml:"EntityAvailabilityStatus,omitempty"`
 		BaseEntityDescription
 	}
+
+	// HubManagementOption provides structure for configuring new Event Hubs
+	HubManagementOption func(description *HubDescription) error
 )
 
 // NewHubManagerFromConnectionString builds a HubManager from an Event Hub connection string
@@ -171,11 +175,34 @@ func (hm *HubManager) Delete(ctx context.Context, name string) error {
 	return err
 }
 
+// HubWithMessageRetentionInDays configures an Event Hub to retain messages for that number of days
+func HubWithMessageRetentionInDays(days int32) HubManagementOption {
+	return func(hd *HubDescription) error {
+		hd.MessageRetentionInDays = &days
+		return nil
+	}
+}
+
+// HubWithPartitionCount configures an Event Hub to have the specified number of partitions. More partitions == more throughput
+func HubWithPartitionCount(count int32) HubManagementOption {
+	return func(hd *HubDescription) error {
+		hd.PartitionCount = &count
+		return nil
+	}
+}
+
 // Put creates or updates an Event Hubs Hub
-func (hm *HubManager) Put(ctx context.Context, name string, hd HubDescription) (*HubEntity, error) {
+func (hm *HubManager) Put(ctx context.Context, name string, opts ...HubManagementOption) (*HubEntity, error) {
 	span, ctx := hm.startSpanFromContext(ctx, "eh.HubManager.Put")
 	defer span.End()
 
+	hd := new(HubDescription)
+	for _, opt := range opts {
+		if err := opt(hd); err != nil {
+			return nil, err
+		}
+	}
+
 	hd.ServiceBusSchema = to.StringPtr(serviceBusSchema)
 
 	he := &hubEntry{
@@ -184,7 +211,7 @@ func (hm *HubManager) Put(ctx context.Context, name string, hd HubDescription) (
 		},
 		Content: &hubContent{
 			Type:           applicationXML,
-			HubDescription: hd,
+			HubDescription: *hd,
 		},
 	}
 

hub_test.go

@@ -162,7 +162,7 @@ func (suite *eventHubSuite) TestHubManagementWrites() {
 }
 
 func testPutHub(ctx context.Context, t *testing.T, hm *HubManager, name string) {
-	hd, err := hm.Put(ctx, name, HubDescription{})
+	hd, err := hm.Put(ctx, name)
 	require.NoError(t, err)
 	require.NotNil(t, hd.PartitionCount)
 	assert.Equal(t, int32(4), *hd.PartitionCount)
@@ -186,7 +186,7 @@ func (suite *eventHubSuite) TestHubManagementReads() {
 
 	names := []string{suite.randEntityName(), suite.randEntityName()}
 	for _, name := range names {
-		if _, err := hm.Put(ctx, name, HubDescription{}); err != nil {
+		if _, err := hm.Put(ctx, name); err != nil {
 			suite.Require().NoError(err)
 		}
 	}

internal/test/suite.go

@@ -133,6 +133,7 @@ func (suite *BaseSuite) RandomHub(opts ...HubMgmtOption) (*mgmt.Model, func()) {
 	name := suite.RandomName("goehtest", 6)
 	model, err := suite.ensureEventHub(ctx, name, opts...)
 	suite.Require().NoError(err)
+	suite.Require().NotNil(model)
 	suite.Require().NotNil(model.PartitionIds)
 	suite.Require().Len(*model.PartitionIds, 4)
 	return model, func() {