show a short list of mount infos: files_external:list --short

[mmattel]

This is a new PR for #32098 because of a push problem killing the commit.

Description

This PR adds an option -s --short to sudo -uwww-data ./occ files_external:list user_id

Related Issue

• Fixes [Feature Request] Improve files_external:list to show a short list of mounts for a given user #32084 ([Feature Request] Improve files_external:list to show a short list of mounts for a given user)

Motivation and Context

The current output of ./occ files_external:list user_id is quite big and for some purposes hard to read. This short view helps when using in conjunction of files:scan with option --path= to identify easily the scannable paths for a user.

How Has This Been Tested?

sudo -uwww-data ./occ files_external:list user_1 --short
+----------+------------------+----------+
| Mount ID | Mount Point      | Type     |
+----------+------------------+----------+
| 1        | /mount_1         | Personal |
| 2        | /mount_2         | Personal |
+----------+------------------+----------+

Screenshots (if appropriate):

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)
• Technical debt
• Tests

Checklist:

• Code changes
• Unit tests added
• Acceptance tests added
• Documentation ticket raised:

Open tasks:

• Backport (if applicable set "backport-request" label and remove when the backport was done)

@PVince81 I added the changes requested from the original PR

[codecov]

Codecov Report

Merging #32178 into master will increase coverage by 0.01%.
The diff coverage is 85.07%.

@@             Coverage Diff              @@
##             master   #32178      +/-   ##
============================================
+ Coverage     64.33%   64.34%   +0.01%     
  Complexity    18305    18305              
============================================
  Files          1195     1195              
  Lines         69193    69228      +35     
  Branches       1276     1276              
============================================
+ Hits          44517    44548      +31     
- Misses        24304    24308       +4     
  Partials        372      372

Flag	Coverage Δ	Complexity Δ
#javascript	52.96% <ø> (ø)	0 <ø> (ø)	⬇️
#phpunit	65.66% <85.07%> (+0.01%)	18305 <0> (ø)	⬇️

Impacted Files	Coverage Δ	Complexity Δ
apps/files_external/lib/Command/ListCommand.php	71.5% <85.07%> (+3.78%)	0 <0> (ø)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a8fa83a...3d7f0b1. Read the comment docs.

[PVince81]

I checked the tests in apps/files_external/tests/Command/ListCommandTest.php
but the do not take care on any existing options anyways.
There is only a check if a json output matches the requirements.
Therefore I skipped tests in the new PR.

Maybe it's a good opportunity to add the missing tests.
My worry is that you added complex-looking logic so it would be good to get it covered somehow, either my calling the private method directly (with self::invokePrivate from the test case class), or by checking for specific output either with assertContains or checking for the full table like it was done in https://github.com/owncloud/core/blob/master/tests/Core/Command/Background/Queue/StatusTest.php#L62

In general we only skip adding tests when dealing with legacy code that would require heavy refactoring to make it testable.

[mmattel]

I understand your point, but do you want to address all the combinations?
And what about all the other files_external commands, there are in total 10 commands...

files_external:list

Arguments:
  user_id                user id to list the personal mounts for, 
                         if no user is provided admin mounts will be listed

Options:
      --show-password    show passwords and secrets
      --full             don't truncate long values in table output
  -a, --all              show both system wide mounts and all personal mounts
  -s, --short            show only a reduced mount info
      --output[=OUTPUT]  The output format to use (plain, json or json_pretty, default is plain).

Second, you hit my weak point: tests (😓) I am very bad in that and have honestly more or less no clue...

[mmattel]

@phil-davis may I ask you for support creating tests?

[phil-davis]

Assigned myself to help with making tests.

[phil-davis]

@mmattel I rebased this just now, to make sure the PR is up-to-date with everything in master. So if you need to touch anything, then make sure to pull down the branch from GitHub first.

[mmattel]

@phil-davis any news on your support offer regarding tests ?
would like to get that merged...

[PVince81]

@sharidas can you help with the unit tests part ?

[phil-davis]

I unassigned myself - I am really not a unit test guy, and have lots of other stuff to do. I should not have offered in the first place, unit tests are more a dev team thing - sorry.

[sharidas]

Unit test status

• Added unit test which verifies with json output
• Formatted table as user see's by default ( like https://github.com/owncloud/core/blob/master/tests/Core/Command/Background/Queue/StatusTest.php#L62 )

@PVince81 I have updated the unit tests. CI looks promising. I would like to have a review for the unit tests added.

PS: The testing is done with 2 mount points.

[PVince81]

👍

[PVince81]

@mmattel please backport

[davitol]

The example in the OP says:

How Has This Been Tested?

sudo -uwww-data ./occ files_external:list user_1 --short
+----------+------------------+----------+
| Mount ID | Mount Point | Type |
+----------+------------------+----------+
| 1 | /mount_1 | Personal |
| 2 | /mount_2 | Personal |
+----------+------------------+----------+

Testing in my own server:

Should we show the mounts with "available for" the user? If not, Is there any other value available for Type Column apart from Personal?

(cc @mmattel)

[mmattel]

Should we show the mounts with "available for" the user?

I already thought about that one...

If not, Is there any other value available for Type Column apart from Personal?

admin