Add partitioned topic command CURD #35

zymap · 2019-09-05T10:42:32Z

Master issue: #2

Modifications

Add commands topic create, delete, update, get-metadata, list.

TODO
need add test for these commands.

OUTPUT

create *

➜  pulsarctl-yong git:(topic-partitioned-commands) ./pulsarctl topic create -h
USED FOR:
    This command is used for creating topic.

REQUIRED PERMISSION:
    This command requires admin permissions.

EXAMPLES:
    #Create non-partitioned topic <topic-name>
    pulsarctl topics create <topic-name> 0

    #Create topic <topic-name> with <partitions-num> partitions
    pulsarctl topics create <topic-name> <partition-num>

OUTPUT:
    #normal output
    Create topic <topic-name> with <partition-num> partitions successfully

    #the topic name and(or) the partitions is not specified
    [✖]  need to specified the topic name and the partitions

    #the topic has been created
    [✖]  code: 409 reason: Partitioned topic already exists

    #the topic name is not in the format of <tenant>/<namespace>/<topic> or <topic>
    [✖]  Invalid short topic name '<topic-name>', it should be in the format of <tenant>/<namespace>/<topic> or <topic>

    #the topic name is not in the format of <domain>://<tenant>/<namespace>/<topic>
    [✖]  Invalid complete topic name '<topic-name>', it should be in the format of <domain>://<tenant>/<namespace>/<topic>

    #the topic name is not in the format of <tenant>/<namespace>/<topic>
    [✖]  Invalid topic name '<topic-name>', it should be in the format of<tenant>/<namespace>/<topic>

    #the namespace name is not in the format of <tenant>/<namespace>
    [✖]  The complete name of namespace is invalid. complete name : <namespace-complete-name>

    #the tenant name and(or) namespace name is empty
    [✖]  Invalid tenant or namespace. [<tenant>/<namespace>]

    #the tenant name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%)  is allowed
    [✖]  Tenant name include unsupported special chars. tenant : [<namespace>]

    #the namespace name contains unsupported special chars. the  alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed
    [✖]  Namespace name include unsupported special chars. namespace : [<namespace>]

Usage: pulsarctl topics create [flags]

Aliases: create, c

delete *

➜  pulsarctl-yong git:(topic-partitioned-commands) ./pulsarctl topic delete -h
USED FOR:
    This command is used for deleting an exist topic.

REQUIRED PERMISSION:
    This command requires admin permissions.

EXAMPLES:
    #Delete a partitioned topic <topic-name>
    pulsarctl topics delete <topic-name>

    #Delete a non-partitioned topic <topic-name>
    pulsarctl topics delete --non-partitioned <topic-name>

OUTPUT:
    #normal output
    Delete topic <topic-name> successfully

    #the topic name is not specified
    [✖]  only one argument is allowed to be used as a name

    #the partitioned topic does not exist
    [✖]  code: 404 reason: Partitioned topic does not exist

    #the non-partitioned topic does not exist
    [✖]  code: 404 reason: Topic not found

    #the topic name is not in the format of <tenant>/<namespace>/<topic> or <topic>
    [✖]  Invalid short topic name '<topic-name>', it should be in the format of <tenant>/<namespace>/<topic> or <topic>

    #the topic name is not in the format of <domain>://<tenant>/<namespace>/<topic>
    [✖]  Invalid complete topic name '<topic-name>', it should be in the format of <domain>://<tenant>/<namespace>/<topic>

    #the topic name is not in the format of <tenant>/<namespace>/<topic>
    [✖]  Invalid topic name '<topic-name>', it should be in the format of<tenant>/<namespace>/<topic>

    #the namespace name is not in the format of <tenant>/<namespace>
    [✖]  The complete name of namespace is invalid. complete name : <namespace-complete-name>

    #the tenant name and(or) namespace name is empty
    [✖]  Invalid tenant or namespace. [<tenant>/<namespace>]

    #the tenant name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%)  is allowed
    [✖]  Tenant name include unsupported special chars. tenant : [<namespace>]

    #the namespace name contains unsupported special chars. the  alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed
    [✖]  Namespace name include unsupported special chars. namespace : [<namespace>]

Usage: pulsarctl topics delete [flags]

Aliases: delete, d

get-metadata *

➜  pulsarctl-yong git:(topic-partitioned-commands) ./pulsarctl topic get-metadata -h
USED FOR:
    This command is used for getting an exist topic.

REQUIRED PERMISSION:
    This command requires admin permissions.

EXAMPLES:
    #Get an exist topic <topic-name> metadata
    pulsarctl topics get-metadata <topic-name>

OUTPUT:
    #normal output
    {
      "partitions": "<partitions>"
    }

    #the topic name is not specified
    [✖]  only one argument is allowed to be used as a name

    #the topic name is not in the format of <tenant>/<namespace>/<topic> or <topic>
    [✖]  Invalid short topic name '<topic-name>', it should be in the format of <tenant>/<namespace>/<topic> or <topic>

    #the topic name is not in the format of <domain>://<tenant>/<namespace>/<topic>
    [✖]  Invalid complete topic name '<topic-name>', it should be in the format of <domain>://<tenant>/<namespace>/<topic>

    #the topic name is not in the format of <tenant>/<namespace>/<topic>
    [✖]  Invalid topic name '<topic-name>', it should be in the format of<tenant>/<namespace>/<topic>

    #the namespace name is not in the format of <tenant>/<namespace>
    [✖]  The complete name of namespace is invalid. complete name : <namespace-complete-name>

    #the tenant name and(or) namespace name is empty
    [✖]  Invalid tenant or namespace. [<tenant>/<namespace>]

    #the tenant name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%)  is allowed
    [✖]  Tenant name include unsupported special chars. tenant : [<namespace>]

    #the namespace name contains unsupported special chars. the  alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed
    [✖]  Namespace name include unsupported special chars. namespace : [<namespace>]

Usage: pulsarctl topics get-metadata [flags]

Aliases: get-metadata, gm

list *

➜  pulsarctl-yong git:(topic-partitioned-commands) ./pulsarctl topic list -h
USED FOR:
    This command is used for listing all exist topics under the specified namespace.

REQUIRED PERMISSION:
    This command requires admin permissions.

EXAMPLES:
    #List all exist topics under the namespace <tenant/namespace>
    pulsarctl topics list <tenant/namespace>

OUTPUT:
    #normal output
    +--------------------------------+--------------------------------+
    |   PUBLIC/DEFAULT PARTITIONED   | PUBLIC/DEFAULT NON-PARTITIONED |
    |             TOPICS             |             TOPICS             |
    +--------------------------------+--------------------------------+
    |                                |                                |
    +--------------------------------+--------------------------------+

    #the namespace is not specified
    [✖]  only one argument is allowed to be used as a name

    #the tenant of the namespace is not exist
    [✖]  code: 404 reason: Tenant does not exist

    #the namespace is not exist
    [✖]  code: 404 reason: Namespace does not exist

    #the namespace name is not in the format of <tenant>/<namespace>
    [✖]  The complete name of namespace is invalid. complete name : <namespace-complete-name>

    #the tenant name and(or) namespace name is empty
    [✖]  Invalid tenant or namespace. [<tenant>/<namespace>]

    #the tenant name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%)  is allowed
    [✖]  Tenant name include unsupported special chars. tenant : [<namespace>]

    #the namespace name contains unsupported special chars. the  alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed
    [✖]  Namespace name include unsupported special chars. namespace : [<namespace>]

Usage: pulsarctl topics list [flags]

Aliases: list, lp

update *

➜  pulsarctl-yong git:(topic-partitioned-commands) ./pulsarctl topic update -h
USED FOR:
    This command is used for updating an exist topic with new partition number.

REQUIRED PERMISSION:
    This command requires admin permissions.

EXAMPLES:
    #
    pulsarctl topics update <topic-name> <partition-num>

OUTPUT:
    #normal output
    Update topic <topic-name> with <partition-num> partitions successfully

    #the topic name and(or) the partitions is not specified
    [✖]  need to specified the topic name and the partitions

    #the partitions number is invalid
    [✖]  invalid partition number '<number>'

    #the topic is not exist
    [✖]  code: 409 reason: Topic is not partitioned topic

    #the topic name is not in the format of <tenant>/<namespace>/<topic> or <topic>
    [✖]  Invalid short topic name '<topic-name>', it should be in the format of <tenant>/<namespace>/<topic> or <topic>

    #the topic name is not in the format of <domain>://<tenant>/<namespace>/<topic>
    [✖]  Invalid complete topic name '<topic-name>', it should be in the format of <domain>://<tenant>/<namespace>/<topic>

    #the topic name is not in the format of <tenant>/<namespace>/<topic>
    [✖]  Invalid topic name '<topic-name>', it should be in the format of<tenant>/<namespace>/<topic>

    #the namespace name is not in the format of <tenant>/<namespace>
    [✖]  The complete name of namespace is invalid. complete name : <namespace-complete-name>

    #the tenant name and(or) namespace name is empty
    [✖]  Invalid tenant or namespace. [<tenant>/<namespace>]

    #the tenant name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%)  is allowed
    [✖]  Tenant name include unsupported special chars. tenant : [<namespace>]

    #the namespace name contains unsupported special chars. the  alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed
    [✖]  Namespace name include unsupported special chars. namespace : [<namespace>]

Usage: pulsarctl topics update [flags]

Aliases: update, up

sijie · 2019-09-05T18:36:59Z

please avoid coupling refactoring with other changes. so revert the refactor please.

also as discussed, lets unify partitioned topic and topic into one set of commands.

zymap · 2019-09-07T09:33:17Z

@sijie PTAL

sijie

Please add the help output for the added commands in the description.

pkg/ctl/cluster/create.go

pkg/ctl/topic/args/args_check.go

pkg/ctl/topic/crud/create.go

pkg/ctl/topic/crud/get.go

pkg/ctl/topic/crud/list.go

pkg/ctl/topic/crud/update.go

sijie · 2019-09-09T18:14:34Z

pkg/ctl/topic/crud/create.go

+		return err
+	}
+
+	partitions, err := strconv.Atoi(vc.NameArgs[1])


It is only checking two args. Please be more specific. SetRunFuncWithTwoNameArgs

pkg/ctl/topic/crud/get.go

zymap · 2019-09-10T07:37:30Z

@sijie PTAL

Master issue: streamnative/pulsarctl#2 *Modifications* Add commands topic `create`, `delete`, `update`, `get-metadata`, `list`. *TODO* need add test for these commands. ## OUTPUT * create * ``` ➜ pulsarctl-yong git:(topic-partitioned-commands) ./pulsarctl topic create -h USED FOR: This command is used for creating topic. REQUIRED PERMISSION: This command requires admin permissions. EXAMPLES: #Create non-partitioned topic <topic-name> pulsarctl topics create <topic-name> 0 #Create topic <topic-name> with <partitions-num> partitions pulsarctl topics create <topic-name> <partition-num> OUTPUT: #normal output Create topic <topic-name> with <partition-num> partitions successfully #the topic name and(or) the partitions is not specified [✖] need to specified the topic name and the partitions #the topic has been created [✖] code: 409 reason: Partitioned topic already exists #the topic name is not in the format of <tenant>/<namespace>/<topic> or <topic> [✖] Invalid short topic name '<topic-name>', it should be in the format of <tenant>/<namespace>/<topic> or <topic> #the topic name is not in the format of <domain>://<tenant>/<namespace>/<topic> [✖] Invalid complete topic name '<topic-name>', it should be in the format of <domain>://<tenant>/<namespace>/<topic> #the topic name is not in the format of <tenant>/<namespace>/<topic> [✖] Invalid topic name '<topic-name>', it should be in the format of<tenant>/<namespace>/<topic> #the namespace name is not in the format of <tenant>/<namespace> [✖] The complete name of namespace is invalid. complete name : <namespace-complete-name> #the tenant name and(or) namespace name is empty [✖] Invalid tenant or namespace. [<tenant>/<namespace>] #the tenant name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed [✖] Tenant name include unsupported special chars. tenant : [<namespace>] #the namespace name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed [✖] Namespace name include unsupported special chars. namespace : [<namespace>] Usage: pulsarctl topics create [flags] Aliases: create, c ``` * delete * ``` ➜ pulsarctl-yong git:(topic-partitioned-commands) ./pulsarctl topic delete -h USED FOR: This command is used for deleting an exist topic. REQUIRED PERMISSION: This command requires admin permissions. EXAMPLES: #Delete a partitioned topic <topic-name> pulsarctl topics delete <topic-name> #Delete a non-partitioned topic <topic-name> pulsarctl topics delete --non-partitioned <topic-name> OUTPUT: #normal output Delete topic <topic-name> successfully #the topic name is not specified [✖] only one argument is allowed to be used as a name #the partitioned topic does not exist [✖] code: 404 reason: Partitioned topic does not exist #the non-partitioned topic does not exist [✖] code: 404 reason: Topic not found #the topic name is not in the format of <tenant>/<namespace>/<topic> or <topic> [✖] Invalid short topic name '<topic-name>', it should be in the format of <tenant>/<namespace>/<topic> or <topic> #the topic name is not in the format of <domain>://<tenant>/<namespace>/<topic> [✖] Invalid complete topic name '<topic-name>', it should be in the format of <domain>://<tenant>/<namespace>/<topic> #the topic name is not in the format of <tenant>/<namespace>/<topic> [✖] Invalid topic name '<topic-name>', it should be in the format of<tenant>/<namespace>/<topic> #the namespace name is not in the format of <tenant>/<namespace> [✖] The complete name of namespace is invalid. complete name : <namespace-complete-name> #the tenant name and(or) namespace name is empty [✖] Invalid tenant or namespace. [<tenant>/<namespace>] #the tenant name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed [✖] Tenant name include unsupported special chars. tenant : [<namespace>] #the namespace name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed [✖] Namespace name include unsupported special chars. namespace : [<namespace>] Usage: pulsarctl topics delete [flags] Aliases: delete, d ``` * get-metadata * ``` ➜ pulsarctl-yong git:(topic-partitioned-commands) ./pulsarctl topic get-metadata -h USED FOR: This command is used for getting an exist topic. REQUIRED PERMISSION: This command requires admin permissions. EXAMPLES: #Get an exist topic <topic-name> metadata pulsarctl topics get-metadata <topic-name> OUTPUT: #normal output { "partitions": "<partitions>" } #the topic name is not specified [✖] only one argument is allowed to be used as a name #the topic name is not in the format of <tenant>/<namespace>/<topic> or <topic> [✖] Invalid short topic name '<topic-name>', it should be in the format of <tenant>/<namespace>/<topic> or <topic> #the topic name is not in the format of <domain>://<tenant>/<namespace>/<topic> [✖] Invalid complete topic name '<topic-name>', it should be in the format of <domain>://<tenant>/<namespace>/<topic> #the topic name is not in the format of <tenant>/<namespace>/<topic> [✖] Invalid topic name '<topic-name>', it should be in the format of<tenant>/<namespace>/<topic> #the namespace name is not in the format of <tenant>/<namespace> [✖] The complete name of namespace is invalid. complete name : <namespace-complete-name> #the tenant name and(or) namespace name is empty [✖] Invalid tenant or namespace. [<tenant>/<namespace>] #the tenant name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed [✖] Tenant name include unsupported special chars. tenant : [<namespace>] #the namespace name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed [✖] Namespace name include unsupported special chars. namespace : [<namespace>] Usage: pulsarctl topics get-metadata [flags] Aliases: get-metadata, gm ``` * list * ``` ➜ pulsarctl-yong git:(topic-partitioned-commands) ./pulsarctl topic list -h USED FOR: This command is used for listing all exist topics under the specified namespace. REQUIRED PERMISSION: This command requires admin permissions. EXAMPLES: #List all exist topics under the namespace <tenant/namespace> pulsarctl topics list <tenant/namespace> OUTPUT: #normal output +--------------------------------+--------------------------------+ | PUBLIC/DEFAULT PARTITIONED | PUBLIC/DEFAULT NON-PARTITIONED | | TOPICS | TOPICS | +--------------------------------+--------------------------------+ | | | +--------------------------------+--------------------------------+ #the namespace is not specified [✖] only one argument is allowed to be used as a name #the tenant of the namespace is not exist [✖] code: 404 reason: Tenant does not exist #the namespace is not exist [✖] code: 404 reason: Namespace does not exist #the namespace name is not in the format of <tenant>/<namespace> [✖] The complete name of namespace is invalid. complete name : <namespace-complete-name> #the tenant name and(or) namespace name is empty [✖] Invalid tenant or namespace. [<tenant>/<namespace>] #the tenant name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed [✖] Tenant name include unsupported special chars. tenant : [<namespace>] #the namespace name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed [✖] Namespace name include unsupported special chars. namespace : [<namespace>] Usage: pulsarctl topics list [flags] Aliases: list, lp ``` * update * ``` ➜ pulsarctl-yong git:(topic-partitioned-commands) ./pulsarctl topic update -h USED FOR: This command is used for updating an exist topic with new partition number. REQUIRED PERMISSION: This command requires admin permissions. EXAMPLES: # pulsarctl topics update <topic-name> <partition-num> OUTPUT: #normal output Update topic <topic-name> with <partition-num> partitions successfully #the topic name and(or) the partitions is not specified [✖] need to specified the topic name and the partitions #the partitions number is invalid [✖] invalid partition number '<number>' #the topic is not exist [✖] code: 409 reason: Topic is not partitioned topic #the topic name is not in the format of <tenant>/<namespace>/<topic> or <topic> [✖] Invalid short topic name '<topic-name>', it should be in the format of <tenant>/<namespace>/<topic> or <topic> #the topic name is not in the format of <domain>://<tenant>/<namespace>/<topic> [✖] Invalid complete topic name '<topic-name>', it should be in the format of <domain>://<tenant>/<namespace>/<topic> #the topic name is not in the format of <tenant>/<namespace>/<topic> [✖] Invalid topic name '<topic-name>', it should be in the format of<tenant>/<namespace>/<topic> #the namespace name is not in the format of <tenant>/<namespace> [✖] The complete name of namespace is invalid. complete name : <namespace-complete-name> #the tenant name and(or) namespace name is empty [✖] Invalid tenant or namespace. [<tenant>/<namespace>] #the tenant name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed [✖] Tenant name include unsupported special chars. tenant : [<namespace>] #the namespace name contains unsupported special chars. the alphanumeric (a-zA-Z0-9) and the special chars (-=:.%) is allowed [✖] Namespace name include unsupported special chars. namespace : [<namespace>] Usage: pulsarctl topics update [flags] Aliases: update, up ```

zymap self-assigned this Sep 5, 2019

zymap added this to the 0.0.1 milestone Sep 5, 2019

zymap added the area/pulsar/topics label Sep 5, 2019

zymap requested review from sijie and wolfstudy and removed request for wolfstudy September 5, 2019 15:05

sijie mentioned this pull request Sep 5, 2019

pulsarctl MVP #2

Closed

29 tasks

zymap added 7 commits September 7, 2019 14:31

Add partitioned topic command CURD

76a8fcc

Revert changes

5c0e462

Add test for command partitioned topic

e3ba23b

Revert the refactor

f2f4ea2

Add non-persistent topic commands

c1e54db

Revert changes

a18f62a

Revert changes

f70a8ec

zymap force-pushed the topic-partitioned-commands branch from 383dac2 to f70a8ec Compare September 7, 2019 06:35

zymap added 2 commits September 7, 2019 16:58

Fix typo

44b32f5

Add partitions value check

d4b5230

zymap added 5 commits September 7, 2019 18:49

Move to a new package

113cc41

import tests

4e271e7

Remove unused code

9a5f6be

Update permission description

35224c5

fix command list error list

3b03dc6

sijie requested changes Sep 9, 2019

View reviewed changes

Address comments

b213f04

zymap force-pushed the topic-partitioned-commands branch from d4986f6 to b213f04 Compare September 9, 2019 15:48

sijie requested changes Sep 9, 2019

View reviewed changes

Address comments

dbb887f

zymap added 2 commits September 10, 2019 15:26

Merge branch 'master' into topic-partitioned-commands

8c707c6

Fix conflict

513b9fd

sijie approved these changes Sep 10, 2019

View reviewed changes

sijie merged commit c32980a into master Sep 10, 2019

wolfstudy deleted the topic-partitioned-commands branch October 11, 2019 06:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add partitioned topic command CURD #35

Add partitioned topic command CURD #35

Uh oh!

zymap commented Sep 5, 2019 •

edited

Loading

Uh oh!

sijie commented Sep 5, 2019

Uh oh!

zymap commented Sep 7, 2019

Uh oh!

sijie left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sijie Sep 9, 2019

Uh oh!

Uh oh!

zymap commented Sep 10, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Add partitioned topic command CURD #35

Add partitioned topic command CURD #35

Uh oh!

Conversation

zymap commented Sep 5, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

OUTPUT

Uh oh!

sijie commented Sep 5, 2019

Uh oh!

zymap commented Sep 7, 2019

Uh oh!

sijie left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sijie Sep 9, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zymap commented Sep 10, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

zymap commented Sep 5, 2019 •

edited

Loading