Adopt pulsar-admin-go sources

Makefile

@@ -29,6 +29,7 @@ GOROOT ?= $(shell go env GOROOT)
 
 build:
 	go build ./pulsar
+	go build ./pulsaradmin
 	go build -o bin/pulsar-perf ./perf
 
 lint: bin/golangci-lint

go.mod

@@ -27,9 +27,11 @@ require (
 	golang.org/x/mod v0.5.1
 	golang.org/x/oauth2 v0.0.0-20210402161424-2e8d93401602
 	golang.org/x/time v0.0.0-20191024005414-555d28b269f0
-	google.golang.org/protobuf v1.30.0 // indirect
+	google.golang.org/protobuf v1.30.0
 )
 
+require github.com/golang/protobuf v1.5.2
+
 require (
 	github.com/99designs/go-keychain v0.0.0-20191008050251-8e49817e8af4 // indirect
 	github.com/ardielle/ardielle-go v1.5.2 // indirect
@@ -39,7 +41,6 @@ require (
 	github.com/dvsekhvalnov/jose2go v1.5.0 // indirect
 	github.com/fsnotify/fsnotify v1.4.9 // indirect
 	github.com/godbus/dbus v0.0.0-20190726142602-4481cbc300e2 // indirect
-	github.com/golang/protobuf v1.5.2 // indirect
 	github.com/golang/snappy v0.0.1 // indirect
 	github.com/gsterjov/go-libsecret v0.0.0-20161001094733-a6f4afe4910c // indirect
 	github.com/inconshreveable/mousetrap v1.0.1 // indirect

go.sum

@@ -551,7 +551,6 @@ google.golang.org/protobuf v1.23.1-0.20200526195155-81db48ad09cc/go.mod h1:EGpAD
 google.golang.org/protobuf v1.24.0/go.mod h1:r/3tXBNzIEhYS9I1OUVjXDlt8tc493IdKGjtUeSXeh4=
 google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c=
 google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
-google.golang.org/protobuf v1.26.0 h1:bxAC2xTBsZGibn2RTntX0oH50xLsqy1OxA9tTL3p/lk=
 google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
 google.golang.org/protobuf v1.30.0 h1:kPPoIgf3TsEvrm0PFe15JQ+570QVxYzEvvHqChK+cng=
 google.golang.org/protobuf v1.30.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=

pulsaradmin/CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# Contributing guidelines
+
+## Project structure
+
+The overall project structure is illustrated below:
+
+```text
+├── pkg/
+│   ├── admin/
+│   │   ├── auth/
+│   │   ├── config/
+│   ├── rest/
+│   └── utils/
+└── alias.go
+```
+
+- The `alias.go` file in the root defines `pulsaradmin` package scope, which contains shortcuts of some types and functions from the `pkg`.
+- The `pkg/admin` package contains all operations for pulsar admin resources. *Note: We should add a new file here if we wanna support a new resource.*
+  - The `pkg/admin/config` package contains configuration options for constructing a pulsar admin client.
+  - The `pkg/admin/auth` package contains auth providers which work in transport layer.
+- The `pkg/rest` package contains a wrapped HTTP client for requesting pulsar REST API.
+- The `pkg/utils` package contains common data structures and functions.
+
+## Contributing steps
+1. Submit an issue describing your proposed change.
+2. Discuss and wait for proposal to be accepted.
+3. Fork this repo, develop and test your code changes.
+4. Submit a pull request.
+
+## Conventions
+
+Please read through below conventions before contributions.
+
+### PullRequest conventions
+
+- Use [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) to standardize PR title.
+
+### Code conventions
+
+- [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments)
+- [Effective Go](https://golang.org/doc/effective_go.html)
+- Know and avoid [Go landmines](https://gist.github.com/lavalamp/4bd23295a9f32706a48f)
+- Commenting
+  - [Go's commenting conventions](http://blog.golang.org/godoc-documenting-go-code)
+  - If reviewers ask questions about why the code is the way it is, that's a sign that comments might be helpful.
+- Naming
+  - Please consider package name when selecting an interface name, and avoid redundancy. For example, `storage.Interface` is better than `storage.StorageInterface`.
+  - Do not use uppercase characters, underscores, or dashes in package names.
+  - Please consider parent directory name when choosing a package name. For example, `pkg/controllers/autoscaler/foo.go` should say `package autoscaler` not `package autoscalercontroller`.
+    - Unless there's a good reason, the `package foo` line should match the name of the directory in which the `.go` file exists.
+    - Importers can use a different name if they need to disambiguate.
+  - Locks should be called `lock` and should never be embedded (always `lock sync.Mutex`). When multiple locks are present, give each lock a distinct name following Go conventions: `stateLock`, `mapLock` etc.
+
+### Folder and file conventions
+
+- All filenames should be lowercase.
+- Go source files and directories use underscores, not dashes.
+  - Package directories should generally avoid using separators as much as possible. When package names are multiple words, they usually should be in nested subdirectories.
+- Document directories and filenames should use dashes rather than underscores.
+- All source files should add a license at the beginning.

pulsaradmin/README.md

@@ -0,0 +1,114 @@
+# Pulsar Admin Go Library
+
+Pulsar-Admin-Go is a [Go](https://go.dev) library for [Apache Pulsar](https://pulsar.apache.org/). It provides a unified Go API for managing pulsar resources such as tenants, namespaces and topics, etc.
+
+## Motivation
+
+Currently, many projects (e.g, [terraform-provider-pulsar](https://github.com/streamnative/terraform-provider-pulsar) and [pulsar-resources-operator](https://github.com/streamnative/pulsar-resources-operator))
+that need to manipulate the pulsar admin resources rely on the [pulsarctl](https://github.com/streamnative/pulsarctl),
+which poses challenges for dependency management and versioning as we have to release a new pulsarctl to get updates.
+So we decoupled the pulsar admin related api from pulsarctl and created the [pulsar-admin-go](https://github.com/apache/pulsar-client-go/pulsaradmin) library based on it,
+which also provides a clearer perspective and maintainability from an architectural perspective.
+
+## Quickstart
+
+### Prerequisite
+
+- go1.18+
+- pulsar-admin-go in go.mod
+
+  ```shell
+  go get github.com/apache/pulsar-client-go
+  ```
+
+### Manage pulsar tenants
+
+- List all tenants
+
+```go
+import (
+    "github.com/apache/pulsar-client-go/pulsaradmin"
+)
+
+func main() {
+    cfg := &pulsaradmin.Config{}
+    admin, err := pulsaradmin.NewClient(cfg)
+    if err != nil {
+        panic(err)
+    }
+
+    tenants, _ := admin.Tenants().List()
+}
+```
+
+### Manage pulsar namespaces
+
+- List all namespaces
+
+```go
+import (
+    "github.com/apache/pulsar-client-go/pulsaradmin"
+)
+
+func main() {
+    cfg := &pulsaradmin.Config{}
+    admin, err := pulsaradmin.NewClient(cfg)
+    if err != nil {
+        panic(err)
+    }
+
+    namespaces, _ := admin.Namespaces().GetNamespaces("public")
+}
+```
+
+- Create a new namespace
+
+```go
+import (
+    "github.com/apache/pulsar-client-go/pulsaradmin"
+)
+
+func main() {
+    cfg := &pulsaradmin.Config{}
+    admin, err := pulsaradmin.NewClient(cfg)
+    if err != nil {
+        panic(err)
+    }
+
+    admin.Namespaces().CreateNamespace("public/dev")
+}
+```
+
+### Manage pulsar topics
+
+- Create a topic
+
+```go
+
+import (
+    "github.com/apache/pulsar-client-go/pulsaradmin"
+    "github.com/apache/pulsar-client-go/pulsaradmin/pkg/utils"
+)
+
+func main() {
+    cfg := &pulsaradmin.Config{}
+    admin, err := pulsaradmin.NewClient(cfg)
+    if err != nil {
+        panic(err)
+    }
+
+    topic, _ := utils.GetTopicName("public/dev/topic")
+
+    admin.Topics().Create(*topic, 3)
+}
+```
+
+## Contributing
+
+Contributions are warmly welcomed and greatly appreciated!
+The project follows the typical GitHub pull request model. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
+Before starting any work, please either comment on an existing issue, or file a new one.
+
+## License
+
+Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).

pulsaradmin/alias.go

@@ -0,0 +1,34 @@
+// 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 pulsaradmin
+
+import (
+	"github.com/apache/pulsar-client-go/pulsaradmin/pkg/admin"
+	"github.com/apache/pulsar-client-go/pulsaradmin/pkg/admin/config"
+)
+
+// Client contains all admin interfaces for operating pulsar resources
+type Client = admin.Client
+
+// Config are the arguments for creating a new admin Client
+type Config = config.Config
+
+var (
+	// NewClient returns a new admin Client for operating pulsar resources
+	NewClient = admin.New
+)

pulsaradmin/pkg/admin/admin.go

@@ -0,0 +1,114 @@
+// 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 (
+	"net/http"
+	"net/url"
+	"path"
+	"time"
+
+	"github.com/apache/pulsar-client-go/pulsaradmin/pkg/admin/auth"
+	"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"
+)
+
+const (
+	DefaultWebServiceURL       = "http://localhost:8080"
+	DefaultHTTPTimeOutDuration = 5 * time.Minute
+	ReleaseVersion             = "None"
+)
+
+type TLSOptions struct {
+	TrustCertsFilePath      string
+	AllowInsecureConnection bool
+}
+
+// Client provides a client to the Pulsar Restful API
+type Client interface {
+	Clusters() Clusters
+	Functions() Functions
+	Tenants() Tenants
+	Topics() Topics
+	Subscriptions() Subscriptions
+	Sources() Sources
+	Sinks() Sinks
+	Namespaces() Namespaces
+	Schemas() Schema
+	NsIsolationPolicy() NsIsolationPolicy
+	Brokers() Brokers
+	BrokerStats() BrokerStats
+	ResourceQuotas() ResourceQuotas
+	FunctionsWorker() FunctionsWorker
+	Packages() Packages
+}
+
+type pulsarClient struct {
+	Client     *rest.Client
+	APIVersion config.APIVersion
+}
+
+// New returns a new client
+func New(config *config.Config) (Client, error) {
+	authProvider, err := auth.GetAuthProvider(config)
+	if err != nil {
+		return nil, err
+	}
+	return NewPulsarClientWithAuthProvider(config, authProvider)
+}
+
+// NewWithAuthProvider creates a client with auth provider.
+// Deprecated: Use NewPulsarClientWithAuthProvider instead.
+func NewWithAuthProvider(config *config.Config, authProvider auth.Provider) Client {
+	client, err := NewPulsarClientWithAuthProvider(config, authProvider)
+	if err != nil {
+		panic(err)
+	}
+	return client
+}
+
+// NewPulsarClientWithAuthProvider create a client with auth provider.
+func NewPulsarClientWithAuthProvider(config *config.Config, authProvider auth.Provider) (Client, error) {
+	if len(config.WebServiceURL) == 0 {
+		config.WebServiceURL = DefaultWebServiceURL
+	}
+
+	return &pulsarClient{
+		APIVersion: config.PulsarAPIVersion,
+		Client: &rest.Client{
+			ServiceURL:  config.WebServiceURL,
+			VersionInfo: ReleaseVersion,
+			HTTPClient: &http.Client{
+				Timeout:   DefaultHTTPTimeOutDuration,
+				Transport: authProvider,
+			},
+		},
+	}, nil
+}
+
+func (c *pulsarClient) endpoint(componentPath string, parts ...string) string {
+	escapedParts := make([]string, len(parts))
+	for i, part := range parts {
+		escapedParts[i] = url.PathEscape(part)
+	}
+	return path.Join(
+		utils.MakeHTTPPath(c.APIVersion.String(), componentPath),
+		path.Join(escapedParts...),
+	)
+}