occ commands to list users and groups by phil-davis · Pull Request #28312 · owncloud/core

phil-davis · 2017-07-05T16:15:17Z

Description

Provide the following new items for the occ command:

ListGroupMembers.php - given a group name, list the members in that group
ListGroups.php - list all groups on the system, with the ability to provide a string and filter the list to show only groups containing that string
ListUserGroups.php - given a User ID, lists the groups which that user is i
ListUsers.php - list all users on the system, with the ability to provide a string and filter the list to show only User IDs containing that string

Related Issue

#28311

Motivation and Context

Help with managing users and groups from the occ command line.

How Has This Been Tested?

Running the occ commands on a test system with various filters, no filtering, with non-existent user and group names.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

Signed-off-by: Phil Davis <phil@jankaritech.com>

phil-davis · 2017-07-05T16:18:34Z

I don't see where there are existing "acceptance tests" that run various occ command line commands and check that the required actions or output actually happened.
@SergioBertolinSG do have that yet?

Because it would be good to know that occ commands do what they claim, both existing ones and these new ones.

SergioBertolinSG · 2017-07-05T16:30:29Z

@phil-davis there are no tests for occ commands currently. There is this PR https://github.com/owncloud/automated-tests/pull/17
Not sure if it is worthy to look at it. They are in python and old.

@PVince81 a couple of questions:

Do we want to check the output of the occ commands?
Do we want to add this to the behat tests?

phil-davis · 2017-07-05T16:35:10Z

Good to know. I would think that occ command tests should be quite easy to add to the integration tests and have behat scenarios. Just needs to go in the backlog of acceptance/integration tests to be written.

mmattel · 2017-07-05T16:36:37Z

@phil-davis
a big thanks for that, really needed.
cant test, businesstrip...
pls add a documentatuon PR ( @settermjd - fyi)

phil-davis · 2017-07-05T16:43:28Z

Doc issue owncloud-archive/documentation#3203 which I will follow up once people have had a chance to review and comment on this PR.

phil-davis · 2017-07-06T07:51:21Z

Feel free to call in anyone else who should give review or feedback on expanding the occ command.

DeepDiver1975 · 2017-07-06T08:42:35Z

+
+use OC\Core\Command\Base;
+use OCP\IGroupManager;
+use Symfony\Component\Console\Command\Command;


DeepDiver1975 · 2017-07-06T08:42:44Z

+use OCP\IGroupManager;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;


DeepDiver1975 · 2017-07-06T08:43:14Z

+		parent::configure();
+
+		$this
+			->setName('group:listmembers')


list-members

please adjust this naming convention to all group commands - THX

The following existing occ commands do not have the "-":
app:getpath
user:lastseen
user:resetpassword
I guess these should not be changed, as that would break backward-compatibility if users have scripted/depend on them.

The following are new commands awaiting release in 10.0.3, so I can change those easily as there are no users depending on them yet:
group:addmember
group:removemember
see #28318

And I will fix the new commands introduced here.

yes - please fix all the new ones - and yes - we failed to name those old ones 😠

anyway - THX

DeepDiver1975 · 2017-07-06T08:44:16Z

+		$groupName = $input->getArgument('group');
+		$group = $this->groupManager->get($groupName);
+		if (!$group) {
+			$output->writeln('<error>Group "' . $groupName . '" does not exist</error>');


I prefer interpolated strings fro better readability

$output->writeln("<error>Group $groupName does not exist</error>");

I copy-pasted this style from other code in these core/Command/... files.
Do I update everywhere so the code will look consistent?

generally speaking I prefer to enhance/change code only if there is a need.
changing code 'just because of making it nice' is not the way to go.

thx

Signed-off-by: Phil Davis <phil@jankaritech.com>

phil-davis · 2017-07-06T09:46:56Z

@DeepDiver1975

Unused "use" removed from the various files
Hyphens added between command words
output string building refactored
It works for me in local testing. Hopefully Travis and Jenkins agree.

DeepDiver1975 · 2017-07-06T09:44:44Z

+			->setName('group:list')
+			->setDescription('list groups')
+			->addArgument(
+				'group',


search pattern or something would match better I guess

Yes, I had 'pattern' in there at one stage yesterday.
If I make it 'searchpattern' do I write it:
'searchpattern' or
'search-pattern' or
'searchPattern'?
(and will do the same style of thing for ListUsers.php)

same naming schema search-pattern - THX

Signed-off-by: Phil Davis <phil@jankaritech.com>

phil-davis · 2017-07-06T13:13:20Z

@DeepDiver1975 IMHO this is good to go

* occ commands to list users and groups Signed-off-by: Phil Davis <phil@jankaritech.com> * Add hyphens to list-members and list-groups occ group commands Signed-off-by: Phil Davis <phil@jankaritech.com> * Use search-pattern as arg in group:list and user:list Signed-off-by: Phil Davis <phil@jankaritech.com>

mmattel · 2017-07-06T15:06:05Z

👍 thanks a lot
As always - pls do not forget documentation... ( @settermjd fyi)

phil-davis · 2017-07-06T16:21:26Z

Doc issue owncloud-archive/documentation#3203 already raised, so it won;t get lost.
I will make the doc additions tomorrow and submit a PR to documentation repo.

* occ commands to list users and groups Signed-off-by: Phil Davis <phil@jankaritech.com> * Add hyphens to list-members and list-groups occ group commands Signed-off-by: Phil Davis <phil@jankaritech.com> * Use search-pattern as arg in group:list and user:list Signed-off-by: Phil Davis <phil@jankaritech.com>

implemented in PR owncloud/core#28312 resolves doc issue #3203

lock · 2019-08-03T04:02:07Z

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

occ commands to list users and groups

828d197

Signed-off-by: Phil Davis <phil@jankaritech.com>

phil-davis requested a review from mmattel July 5, 2017 16:15

phil-davis mentioned this pull request Jul 5, 2017

New occ user and group listing commands owncloud-archive/documentation#3203

Closed

phil-davis requested review from PVince81 and SergioBertolinSG July 6, 2017 07:50

phil-davis added 3 - To Review comp:console-occ labels Jul 6, 2017

DeepDiver1975 requested changes Jul 6, 2017

View reviewed changes

Add hyphens to list-members and list-groups occ group commands

ef25bf0

Signed-off-by: Phil Davis <phil@jankaritech.com>

DeepDiver1975 requested changes Jul 6, 2017

View reviewed changes

phil-davis added this to the development milestone Jul 6, 2017

Use search-pattern as arg in group:list and user:list

0fad47e

Signed-off-by: Phil Davis <phil@jankaritech.com>

phil-davis mentioned this pull request Jul 6, 2017

Add hyphens to add-member and remove-member occ group commands #28318

Merged

9 tasks

DeepDiver1975 approved these changes Jul 6, 2017

View reviewed changes

DeepDiver1975 merged commit de2ef05 into master Jul 6, 2017

DeepDiver1975 deleted the occ-list-users-groups branch July 6, 2017 14:24

phil-davis mentioned this pull request Jul 6, 2017

[stable10] occ commands to list users and groups #28325

Closed

phil-davis mentioned this pull request Jul 6, 2017

[stable10] occ commands to list users and groups #28328

Merged

phil-davis added a commit to owncloud-archive/documentation that referenced this pull request Jul 7, 2017

Doc for occ group and user list commands

dcbf584

implemented in PR owncloud/core#28312 resolves doc issue #3203

phil-davis mentioned this pull request Jul 7, 2017

Doc for occ group and user list commands owncloud-archive/documentation#3208

Merged

individual-it mentioned this pull request Jul 13, 2017

Provide occ commands to list users and groups #28311

Closed

individual-it mentioned this pull request Aug 28, 2017

Need the ability to list users #27813

Closed

settermjd pushed a commit to owncloud-archive/documentation that referenced this pull request Oct 20, 2017

Doc for occ group and user list commands

93f7754

implemented in PR owncloud/core#28312 resolves doc issue #3203

ownclouders added the status/STALE label Dec 20, 2017

lock Bot locked as resolved and limited conversation to collaborators Aug 3, 2019

Uh oh!

Conversation

phil-davis commented Jul 5, 2017

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

Uh oh!

phil-davis commented Jul 5, 2017

Uh oh!

SergioBertolinSG commented Jul 5, 2017

Uh oh!

phil-davis commented Jul 5, 2017

Uh oh!

mmattel commented Jul 5, 2017

Uh oh!

phil-davis commented Jul 5, 2017

Uh oh!

phil-davis commented Jul 6, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

phil-davis Jul 6, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

phil-davis commented Jul 6, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

phil-davis commented Jul 6, 2017

Uh oh!

mmattel commented Jul 6, 2017

Uh oh!

phil-davis commented Jul 6, 2017

Uh oh!

lock Bot commented Aug 3, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

phil-davis Jul 6, 2017 •

edited

Loading