PoC: Git/SSH Proxy ("grok")

[koobs]

Summary / Definition of Done

A user with write access to bsdlabs/ports ("source") can submit a pull request that is automatically fetched, applied and merged to bsdlabs/freebsd-ports ("target") without manual intervention to which they have no access.

Create a software component that

• Is deployable on third-party system
• Takes (pull request) events (via webhooks) from GitHub
• Takes the code from the pull request
• Tests/Applies it to a source repository (bsdlabs/ports)
• Tests/Merges it to a target 'repository' (bsdlabs/freebsd-ports)
  • Using an SSH key (allowed to write to target repository)

PoC Scope does not include

• Error handling (failed merge)
• Commenting, closing or otherwise taking any action on originating Pull Request

Notes

1. source repository: bsdlabs/ports - should be a 'sparse' fork of official ports, only containing category/portname directories submitted to that repository
2. target repository: bsdlabs/freebsd-ports - should be a fork/mirror of official ports (a full tree)

[koobs]

@kfv Is going to be away for 2-3 weeks. @kfv Could you please:

• Push grok code
• Land Create README #2
• Provide any information we might need to deploy the PoC in your absence

[kfv]

Sure, tomorrow I will do it.

[kfv]

Code is available on the PoC branch.

---

To install the binary:

cargo install --path <path-to-the-project>

To use the binary, make sure to put grok.conf under /usr/local/etc/grok/grok.conf.

The source and target in the configuration file are vectors of the RepoStruct:

user:     optional username                 (does nothing at the moment)
provider: optional                          (does nothing at the moment)
repo:     github repository                 (required)
key:      path to the ssh-key for pull/push (required)

To work with several repositories, make sure to list them in order. They zip together. For example:

...
[repositories]
source = [{repo = "a/source", key = "/path/to/key"}, {repo = "b/source", key = "/path/to/key"}]
target = [{repo = "a/target", key = "/path/to/key"}, {repo = "b/target", key = "/path/to/key"}]
...

Run grok with nohup in background.

Don't forget to add GitHub webhooks for anything related to PRs.

The design is not clean and nor is the code itself. So let me know if you need any bug fixes, and I will push the required changes. I'll refactor the project when I'm back (gradually.)

---

bsdlabs/ports and bsdlabs/freebsd-ports:

For test purposes, we just need a sparse checkout of the the bsdlabs/freebsd-ports (forked from freebsd/freebsd-ports) in bsdlabs/ports. We don't even need to automatically update the target or keep it in sync with the upstream.