Mimic wstool info output #246

tdenewiler · 2022-08-03T21:28:54Z

This adds support for vcs repos that gives output similar to that from wstool info output. Related to #196 and #209.

So far, only the git client supports this type of output. If there is interest I would appreciate help with the other clients, and would be willing to devote some time to it over the next couple months to get it over the finish line.

Testing

From a workspace, run vcs repos. I created a workspace using a subset of the repositories listed in the Gist at https://gist.github.com/nuclearsandwich/71c12be27e526ef8de4e997975bdb787. Without making changes the current output is

$ vcs repos
....
Localname               S      SCM Version UID          URI                                       
---------               -      --- ------- ---          ---                                       
src/ament/ament_cmake   -      git master  65a3ad5f128e https://github.com/ament/ament_cmake.git  
src/ament/ament_index   -      git master  496403d08658 https://github.com/ament/ament_index.git  
src/ament/ament_lint    -      git master  96d9ca4fd32b https://github.com/ament/ament_lint.git   
src/ament/ament_package -      git master  6098894352c4 https://github.com/ament/ament_package.git

If one of the files is modified in ament_package this is the output.

$ vcs repos 
....
Localname               S      SCM Version UID          URI                                       
---------               -      --- ------- ---          ---                                       
src/ament/ament_cmake   -      git master  65a3ad5f128e https://github.com/ament/ament_cmake.git  
src/ament/ament_index   -      git master  496403d08658 https://github.com/ament/ament_index.git  
src/ament/ament_lint    -      git master  96d9ca4fd32b https://github.com/ament/ament_lint.git   
src/ament/ament_package M      git master  6098894352c4 https://github.com/ament/ament_package.git

If an untracked file is added (I did touch x in ament_packages) this is the output.

$ vcs repos 
....
Localname               S      SCM Version UID          URI                                       
---------               -      --- ------- ---          ---                                       
src/ament/ament_cmake   -      git master  65a3ad5f128e https://github.com/ament/ament_cmake.git  
src/ament/ament_index   -      git master  496403d08658 https://github.com/ament/ament_index.git  
src/ament/ament_lint    -      git master  96d9ca4fd32b https://github.com/ament/ament_lint.git   
src/ament/ament_package ??     git master  6098894352c4 https://github.com/ament/ament_package.git

…ne of details per repository.

nuclearsandwich · 2022-09-02T16:37:09Z

I don't have permissions to approve workflow runs on this repository but I've pushed a copy of this branch to my fork in order to run the action there https://github.com/nuclearsandwich/vcstool/actions/runs/2980535291

tdenewiler · 2022-09-02T16:51:41Z

I don't have permissions to approve workflow runs on this repository but I've pushed a copy of this branch to my fork in order to run the action there https://github.com/nuclearsandwich/vcstool/actions/runs/2980535291

Thanks @nuclearsandwich! There are some linting issues. I will try to run the workflows on my fork (following your example) and fix those before requesting any more attention.

…u test matrix.

… versions.

tdenewiler · 2022-09-02T17:25:39Z

Workflow was failing due to an upstream issue. Take care when reading the comments :(

tholo/pytest-flake8#87

nuclearsandwich · 2022-09-06T00:14:16Z

Workflow was failing due to an upstream issue.

Yeah, in #247 I've pinned the flake8 version back so that CI is working while we figure out a strategy that will work for most of ROS Infrastructure. I plan to merge that PR into my fork's default branch tomorrow if you would like to use that as a basis for running actions on your fork or even opening a PR targeting mine you'd be welcome to do so.

With that in mind I think that it is still worth:

Keeping all of the review / discussion on this pull request even if we have to link elsewhere for Actions results.
Not merging my CI fixes directly into this PR branch unless you're comfortable rebasing them out once that PR is either merged or altered in order to pass review.

tdenewiler · 2022-10-12T17:25:04Z

In the first comment I showed the workspace I am using for testing. It contains only git repositories. Does anyone have good examples of other types of ROS(2) repositories I could use as part of a testing workspace? I am looking for the following repository types:

bzr
hg
svn
tar
zip

tdenewiler · 2022-10-12T17:37:31Z

Nevermind about the list of repositories of different types. There is a list.repos file in the tests directory.

… Placeholder values used outside of bzr trunk.

tdenewiler · 2022-10-19T21:09:53Z

example.txt

All 4 VCS types now have support. I have attached an example repos file (example.txt) that you can use to create a worksapce and see the results. Note that there might be a better way to get the bzr repo into the workspace but I am not familiar enough to know how to do that.

mkdir -p /tmp/example_ws/src
cd /tmp/example_ws
vcs import src < example.txt
mkdir src/bzr
cd src/bzr
bzr branch lp:gwibber
cd /tmp/example_ws
vcs repos

The output should look like the following.

.............
Localname               S      SCM Version    UID                                  URI                                                           
---------               -      --- -------    ---                                  ---                                                           
src/ament/ament_cmake   -      git master     799183ab9bcf                         https://github.com/ament/ament_cmake.git                      
src/ament/ament_index   -      git master     23da167ecf38                         https://github.com/ament/ament_index.git                      
src/ament/ament_lint    -      git master     bbdaa17224f3                         https://github.com/ament/ament_lint.git                       
src/ament/ament_package -      git master     122af3e498dc                         https://github.com/ament/ament_package.git                    
src/bzr/gwibber         -      bzr 1449       k6jr58pbmqk27mda                     http://bazaar.launchpad.net/~gwibber-committers/gwibber/trunk/
src/hg/branch           -      hg  stable     805419729e11                         https://www.mercurial-scm.org/repo/hg-stable                  
src/hg/hash             -      hg  stable     6d79894d3460                         https://www.mercurial-scm.org/repo/hg-stable                  
src/hg/tag              -      hg  stable     067f2c53fb24                         https://www.mercurial-scm.org/repo/hg-stable                  
src/immutable/hash      -      git <detached> 377d5b3d03c2                         https://github.com/dirk-thomas/vcstool.git                    
src/immutable/tag       -      git 0.1.27     bf9ca56de693                         https://github.com/dirk-thomas/vcstool.git                    
src/svn/rev             -      svn 635        ec8ed9e5-419c-173f-15d3-ce57b7db7bff https://github.com/dirk-thomas/vcstool                        
src/vcstool             -      git master     daf389377310                         https://github.com/dirk-thomas/vcstool.git                    
src/without_version     -      git master     daf389377310                         https://github.com/dirk-thomas/vcstool.git

tdenewiler · 2022-10-26T03:35:20Z

Using the tabulate package the output should look like this.

$ vcs repos
.............
+-------------------------+--------+-----+------------+--------------------------------------+----------------------------------------------------------------+
| localname               | status | scm | version    | uid                                  | uri                                                            |
+-------------------------+--------+-----+------------+--------------------------------------+----------------------------------------------------------------+
| src/ament/ament_cmake   | -      | git | master     | 799183ab9bcf                         | https://github.com/ament/ament_cmake.git                       |
| src/ament/ament_index   | -      | git | master     | 23da167ecf38                         | https://github.com/ament/ament_index.git                       |
| src/ament/ament_lint    | -      | git | master     | bbdaa17224f3                         | https://github.com/ament/ament_lint.git                        |
| src/ament/ament_package | -      | git | master     | 122af3e498dc                         | https://github.com/ament/ament_package.git                     |
| src/bzr/gwibber         | -      | bzr | 1449       | k6jr58pbmqk27mda                     | http://bazaar.launchpad.net/~gwibber-committers/gwibber/trunk/ |
| src/hg/branch           | -      | hg  | stable     | f0a3aaa07d6a                         | https://www.mercurial-scm.org/repo/hg-stable                   |
| src/hg/hash             | -      | hg  | stable     | 6d79894d3460                         | https://www.mercurial-scm.org/repo/hg-stable                   |
| src/hg/tag              | -      | hg  | stable     | 067f2c53fb24                         | https://www.mercurial-scm.org/repo/hg-stable                   |
| src/immutable/hash      | -      | git | <detached> | 377d5b3d03c2                         | https://github.com/dirk-thomas/vcstool.git                     |
| src/immutable/tag       | -      | git | 0.1.27     | bf9ca56de693                         | https://github.com/dirk-thomas/vcstool.git                     |
| src/svn/rev             | -      | svn | 3          | ec8ed9e5-419c-173f-15d3-ce57b7db7bff | https://github.com/dirk-thomas/vcstool                         |
| src/vcstool             | -      | git | master     | daf389377310                         | https://github.com/dirk-thomas/vcstool.git                     |
| src/without_version     | -      | git | master     | daf389377310                         | https://github.com/dirk-thomas/vcstool.git                     |
+-------------------------+--------+-----+------------+--------------------------------------+----------------------------------------------------------------+

nuclearsandwich · 2022-11-04T18:26:45Z

I haven't done a full review since the last time I looked but I would strongly prefer not introducing an additional dependency. I think the previous output demo was good enough and the additional package isn't required.

This reverts commit b7144fa.

This reverts commit ef622de.

This reverts commit 2f95e9b.

This reverts commit 0eb8487.

tdenewiler · 2023-02-09T16:22:48Z

I reverted the use of a new dependency for printing out the results. This branch is working for me when I run it locally. That said, my workspaces are almost entirely made of git repositories so I have not done extensive testing of most of the interfaces. I did update the tests for the other VCS interfaces and those are passing, and I have an example workspace with one of each VCS type that this is working for.

If anyone has time it would be nice to get this reviewed. I think it would be a nice addition to the existing tool if we could get it published.

tdenewiler · 2023-07-07T18:37:47Z

Just checking in to see if this can get merged? Our team internally is using this branch in a custom virtual environment more often and it would be nice if the repos verb was available in a standard install. I'm happy to help if anything else needs to be done. Thanks.

tdenewiler · 2023-07-17T23:04:34Z

Note that teams I work on are using the following command to get access to the repos verb in our Python venvs.

pip install git+https://github.com/tdenewiler/vcstool@wstool-info-output

tdenewiler added 5 commits April 6, 2022 14:07

Add new repos command to give report similar to wstool output. One li…

aebd5e2

…ne of details per repository.

Black formatting.

83979c3

Remove Python 3.5, 3.6 from test environment.

d60783b

Nicely print out results for repos command.

09ce4f1

Handle result output functions with varying number of arguments.

23e2f76

tdenewiler changed the title ~~Mimic wstool info output~~ [WIP] Mimic wstool info output Aug 3, 2022

tdenewiler mentioned this pull request Aug 15, 2022

Status of vcstool #242

Open

tdenewiler marked this pull request as draft August 16, 2022 04:12

Allow manual trigger of workflows. Add newer Python versions to Ubunt…

e1a7952

…u test matrix.

tdenewiler closed this Sep 2, 2022

tdenewiler added 3 commits September 2, 2022 10:03

Fix syntax for Python versions.

11e7794

Pin version of flake8 to less than 5 to fix upstream bug.

786c87c

Switch to requirements.txt for dependencies to better support pinning…

041636c

… versions.

tdenewiler reopened this Sep 2, 2022

tdenewiler added 4 commits October 12, 2022 13:27

Add repos support for hg, svn, and bzr clients.

d74152a

Update bzr client for repos command, almost working.

8927f91

Set default values for bzr client and fill in if available.

57b0340

bzr client works in trunk of repo but not anywhere else in workspace.…

bfe1389

… Placeholder values used outside of bzr trunk.

tdenewiler added 2 commits October 19, 2022 14:10

Improve discovery of bzr URL field.

20fb668

Code style cleanup and tests passing.

5f94c26

tdenewiler changed the title ~~[WIP] Mimic wstool info output~~ Mimic wstool info output Oct 19, 2022

tdenewiler marked this pull request as ready for review October 19, 2022 21:27

Simplify printing repos results by using the tabulate package.

0eb8487

tdenewiler added 3 commits October 25, 2022 20:16

Add tabulate package to required installs.

2f95e9b

Fix flake8 warnings.

ef622de

Install tabulate as part of CI workflow.

b7144fa

tdenewiler added 4 commits January 3, 2023 07:53

Revert "Install tabulate as part of CI workflow."

d7aa3ee

This reverts commit b7144fa.

Revert "Fix flake8 warnings."

3cd63bc

This reverts commit ef622de.

Revert "Add tabulate package to required installs."

0d57265

This reverts commit 2f95e9b.

Revert "Simplify printing repos results by using the tabulate package."

16d9309

This reverts commit 0eb8487.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mimic wstool info output #246

Mimic wstool info output #246

tdenewiler commented Aug 3, 2022

nuclearsandwich commented Sep 2, 2022

tdenewiler commented Sep 2, 2022

tdenewiler commented Sep 2, 2022

nuclearsandwich commented Sep 6, 2022

tdenewiler commented Oct 12, 2022

tdenewiler commented Oct 12, 2022

tdenewiler commented Oct 19, 2022

tdenewiler commented Oct 26, 2022

nuclearsandwich commented Nov 4, 2022

tdenewiler commented Feb 9, 2023

tdenewiler commented Jul 7, 2023

tdenewiler commented Jul 17, 2023

Mimic wstool info output #246

Are you sure you want to change the base?

Mimic wstool info output #246

Conversation

tdenewiler commented Aug 3, 2022

nuclearsandwich commented Sep 2, 2022

tdenewiler commented Sep 2, 2022

tdenewiler commented Sep 2, 2022

nuclearsandwich commented Sep 6, 2022

tdenewiler commented Oct 12, 2022

tdenewiler commented Oct 12, 2022

tdenewiler commented Oct 19, 2022

tdenewiler commented Oct 26, 2022

nuclearsandwich commented Nov 4, 2022

tdenewiler commented Feb 9, 2023

tdenewiler commented Jul 7, 2023

tdenewiler commented Jul 17, 2023