This is an automated email from the ASF dual-hosted git repository.
zike pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar-client-go.git
The following commit(s) were added to refs/heads/master by this push:
new 3388eae9 [Improve] Implement GetTopicAutoCreation (#1151)
3388eae9 is described below
commit 3388eae9f03f43b1446c3dd573a104b3f95fe302
Author: jiangpengcheng <[email protected]>
AuthorDate: Tue Jan 9 12:01:50 2024 +0800
[Improve] Implement GetTopicAutoCreation (#1151)
### Motivation
The `GetTopicAutoCreation` endpoint is missed, needs to add it
### Modifications
Implement the `GetTopicAutoCreation` method
---
pulsaradmin/pkg/admin/namespace.go | 10 ++
pulsaradmin/pkg/admin/namespace_test.go | 175 ++++++++++++++++++++++++++++++++
2 files changed, 185 insertions(+)
diff --git a/pulsaradmin/pkg/admin/namespace.go
b/pulsaradmin/pkg/admin/namespace.go
index 732441e8..782ae3ae 100644
--- a/pulsaradmin/pkg/admin/namespace.go
+++ b/pulsaradmin/pkg/admin/namespace.go
@@ -75,6 +75,9 @@ type Namespaces interface {
// RemoveBacklogQuota removes a backlog quota policy from a namespace
RemoveBacklogQuota(namespace string) error
+ // GetTopicAutoCreation returns the topic auto-creation config for a
namespace
+ GetTopicAutoCreation(namespace utils.NameSpaceName)
(*utils.TopicAutoCreationConfig, error)
+
// SetTopicAutoCreation sets topic auto-creation config for a
namespace, overriding broker settings
SetTopicAutoCreation(namespace utils.NameSpaceName, config
utils.TopicAutoCreationConfig) error
@@ -445,6 +448,13 @@ func (n *namespaces) RemoveBacklogQuota(namespace string)
error {
return n.pulsar.Client.DeleteWithQueryParams(endpoint, params)
}
+func (n *namespaces) GetTopicAutoCreation(namespace utils.NameSpaceName)
(*utils.TopicAutoCreationConfig, error) {
+ var topicAutoCreation utils.TopicAutoCreationConfig
+ endpoint := n.pulsar.endpoint(n.basePath, namespace.String(),
"autoTopicCreation")
+ err := n.pulsar.Client.Get(endpoint, &topicAutoCreation)
+ return &topicAutoCreation, err
+}
+
func (n *namespaces) SetTopicAutoCreation(namespace utils.NameSpaceName,
config utils.TopicAutoCreationConfig) error {
endpoint := n.pulsar.endpoint(n.basePath, namespace.String(),
"autoTopicCreation")
return n.pulsar.Client.Post(endpoint, &config)
diff --git a/pulsaradmin/pkg/admin/namespace_test.go
b/pulsaradmin/pkg/admin/namespace_test.go
new file mode 100644
index 00000000..f934a968
--- /dev/null
+++ b/pulsaradmin/pkg/admin/namespace_test.go
@@ -0,0 +1,175 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package admin
+
+import (
+ "testing"
+
+ "github.com/apache/pulsar-client-go/pulsaradmin/pkg/admin/config"
+ "github.com/apache/pulsar-client-go/pulsaradmin/pkg/rest"
+ "github.com/apache/pulsar-client-go/pulsaradmin/pkg/utils"
+ "github.com/stretchr/testify/assert"
+ "github.com/stretchr/testify/require"
+)
+
+func ptr(n int) *int {
+ return &n
+}
+
+func TestSetTopicAutoCreation(t *testing.T) {
+ config := &config.Config{}
+ admin, err := New(config)
+ require.NoError(t, err)
+ require.NotNil(t, admin)
+
+ tests := []struct {
+ name string
+ namespace string
+ config utils.TopicAutoCreationConfig
+ errReason string
+ }{
+ {
+ name: "Set partitioned type topic auto creation",
+ namespace: "public/default",
+ config: utils.TopicAutoCreationConfig{
+ Allow: true,
+ Type: utils.Partitioned,
+ Partitions: ptr(3),
+ },
+ errReason: "",
+ },
+ {
+ name: "Set partitioned type topic auto creation
without partitions",
+ namespace: "public/default",
+ config: utils.TopicAutoCreationConfig{
+ Allow: true,
+ Type: utils.Partitioned,
+ },
+ errReason: "Invalid configuration for
autoTopicCreationOverride. the detail is [defaultNumPartitions] " +
+ "cannot be null when the type is partitioned.",
+ },
+ {
+ name: "Set partitioned type topic auto creation
with partitions < 1",
+ namespace: "public/default",
+ config: utils.TopicAutoCreationConfig{
+ Allow: true,
+ Type: utils.Partitioned,
+ Partitions: ptr(-1),
+ },
+ errReason: "Invalid configuration for
autoTopicCreationOverride. the detail is [defaultNumPartitions] " +
+ "cannot be less than 1 for partition type.",
+ },
+ {
+ name: "Set non-partitioned type topic auto
creation",
+ namespace: "public/default",
+ config: utils.TopicAutoCreationConfig{
+ Allow: true,
+ Type: utils.NonPartitioned,
+ },
+ errReason: "",
+ },
+ {
+ name: "Set non-partitioned type topic auto
creation with partitions",
+ namespace: "public/default",
+ config: utils.TopicAutoCreationConfig{
+ Allow: true,
+ Type: utils.NonPartitioned,
+ Partitions: ptr(3),
+ },
+ errReason: "Invalid configuration for
autoTopicCreationOverride. the detail is [defaultNumPartitions] is " +
+ "not allowed to be set when the type is
non-partition.",
+ },
+ {
+ name: "Disable topic auto creation",
+ namespace: "public/default",
+ config: utils.TopicAutoCreationConfig{
+ Allow: false,
+ },
+ errReason: "",
+ },
+ {
+ name: "Set topic auto creation on a non-exist
namespace",
+ namespace: "public/nonexist",
+ config: utils.TopicAutoCreationConfig{
+ Allow: true,
+ Type: utils.NonPartitioned,
+ },
+ errReason: "Namespace does not exist",
+ },
+ {
+ name: "Set topic auto creation on a non-exist
tenant",
+ namespace: "non-exist/default",
+ config: utils.TopicAutoCreationConfig{
+ Allow: true,
+ Type: utils.NonPartitioned,
+ },
+ errReason: "Tenant does not exist",
+ },
+ }
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ namespace, _ := utils.GetNamespaceName(tt.namespace)
+ err :=
admin.Namespaces().SetTopicAutoCreation(*namespace, tt.config)
+ if tt.errReason == "" {
+ assert.Equal(t, nil, err)
+
+ err =
admin.Namespaces().RemoveTopicAutoCreation(*namespace)
+ assert.Equal(t, nil, err)
+ }
+ if err != nil {
+ restError := err.(rest.Error)
+ assert.Equal(t, tt.errReason, restError.Reason)
+ }
+ })
+ }
+}
+
+func TestGetTopicAutoCreation(t *testing.T) {
+ config := &config.Config{}
+ admin, err := New(config)
+ require.NoError(t, err)
+ require.NotNil(t, admin)
+
+ namespace, _ := utils.GetNamespaceName("public/default")
+
+ // set the topic auto creation config and get it
+ err = admin.Namespaces().SetTopicAutoCreation(*namespace,
utils.TopicAutoCreationConfig{
+ Allow: true,
+ Type: utils.NonPartitioned,
+ })
+ assert.Equal(t, nil, err)
+ topicAutoCreation, err :=
admin.Namespaces().GetTopicAutoCreation(*namespace)
+ assert.Equal(t, nil, err)
+ expected := utils.TopicAutoCreationConfig{
+ Allow: true,
+ Type: utils.NonPartitioned,
+ }
+ assert.Equal(t, expected, *topicAutoCreation)
+
+ // remove the topic auto creation config and get it
+ err = admin.Namespaces().RemoveTopicAutoCreation(*namespace)
+ assert.Equal(t, nil, err)
+
+ topicAutoCreation, err =
admin.Namespaces().GetTopicAutoCreation(*namespace)
+ assert.Equal(t, nil, err)
+ expected = utils.TopicAutoCreationConfig{
+ Allow: false,
+ Type: "",
+ }
+ assert.Equal(t, expected, *topicAutoCreation)
+}
