Add CLI tool for easy push approval for administrators

[msagi]

Fixes #481 .

Using the CLI

Prerequisites

• Proxy and REST API are running (default behaviour)
• The Git Proxy URL is configured via the GIT_PROXY_UI_URL environment variable (defaults to http://localhost:8080). Note: this documentation assumes that Git Proxy UI is running on http://git-proxy.com:8080.
• Intercepting a push instructions have been followed and you've reached Push via Git Proxy

Instructions

1. Find the tracking ID

Following on from Push via Git Proxy, you'll receive a unique URL:

http://localhost:8080/requests/0000000000000000000000000000000000000000__79b4d8953cbc324bcc1eb53d6412ff89666c241f

The ID for your push corresponds to the last part of the URL:

0000000000000000000000000000000000000000__79b4d8953cbc324bcc1eb53d6412ff89666c241f

2. Authenticate with the CLI

Use the default & auto-generated Git Proxy username & password credentials to authenticate and obtain a cookie. The cookie value is saved to a file (git-proxy-cookie):

$ npm run-script cli -- login --username admin --password admin
Git-Proxy URL: http://git-proxy.com:8080
Auth 'admin': OK

3. Approve the push with ID

Use the commit ID to approve your push with the CLI:

$ npm run-script cli -- approve --commitId 0000000000000000000000000000000000000000__79b4d8953cbc324bcc1eb53d6412ff89666c241f
Git-Proxy URL: http://git-proxy.com:8080
Approve: ID: '0000000000000000000000000000000000000000__79b4d8953cbc324bcc1eb53d6412ff89666c241f': OK

4. Re-push your code

Execute git push to send your approved code through Git Proxy to the upstream repository:

$ git push
Enumerating objects: 5, done.
Counting objects: 100% (5/5), done.
Delta compression using up to 10 threads
Compressing objects: 100% (3/3), done.
Writing objects: 100% (3/3), 470 bytes | 470.00 KiB/s, done.
Total 3 (delta 2), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (2/2), completed with 2 local objects.

5. Log out

Clean up your connect cookie via logging out:

$ npm run-script cli -- logout
Git-Proxy URL: http://git-proxy.com:8080
Logout: OK

[netlify]

✅ Deploy Preview for endearing-brigadeiros-63f9d0 canceled.

Name	Link
🔨 Latest commit	d037f9e
🔍 Latest deploy log	https://app.netlify.com/sites/endearing-brigadeiros-63f9d0/deploys/6615a3f9c35c26000857afb7

[socket-security]

No dependency changes detected. Learn more about Socket for GitHub ↗︎

👍 No dependency changes detected in pull request

[codecov]

Codecov Report

Attention: Patch coverage is 75.00000% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 64.23%. Comparing base (f3fd0ee) to head (d037f9e).

Files	Patch %	Lines
src/service/routes/push.js	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #482      +/-   ##
==========================================
+ Coverage   57.35%   64.23%   +6.87%     
==========================================
  Files          39       40       +1     
  Lines        1060     1191     +131     
==========================================
+ Hits          608      765     +157     
+ Misses        452      426      -26     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[JamieSlome]

@msagi - are the CLI commands runnable via npx as well? 👍

[msagi]

Refactored the CLI tool to be a package, incorporated @JamieSlome 's feedback from his comments.

[coopernetes]

Overall, solid on implementation. A few odds & ends to address.

[JamieSlome]

@msagi - for your and reference of others reviewing this pull request, the following issue has been opened to address the precedent of failing status checks:

#519

Moreover, #520 has been opened to address the issue itself.

[JamieSlome]

LGTM! 🍰

[JamieSlome]

@coopernetes - still got an outstanding "requested changes" status on this pull request from you. Are you able to resolve and we can merge the pull request? 👍

[coopernetes]

LGTM, merge it, ship it 🚀