Proposal: create common distribution formats #8
Comments
|
I like it. I did consider creating a brew installer a while ago, but I looked at the criteria for inclusion, and it had something about not being able to be installed via other package managers, and not being able to be submitted by the author of the tool itself. Hopefully we can work around this. |
|
Yeah, they can be a bit picky. There are more rigorous rules for the main brew repo, but you can tap other repos (or even just create one in our repo). |
|
I think we still want the single standalone package with everything together for embedding in the native libraries, because of the size of the Ruby runtime. |
|
Ah yes, I only just learned about making your own brew repos. It's a good backup plan. |
Initial thoughtsLooking at the size of the pact-plugin-cli executable (11mb) I am inclined to suggest we seperate out and publish two sets of packages
├── pact
├── pactflow
├── pact-broker
├── pact-message
├── pact-mock-service
├── pact-stub-service
├── pact-provider-verifier
├── pact_mock_server_cli
├── pact-stub-server
├── pact_verifier_cli
└── pact-plugin-cliIf that is produced in one place, its easy for HomeBrew / Scoop and our scripted installed to provide a ruby-standalone or full-fat cli experience. Ideally we could use Rust going forward as a way to provide a directory to install all the cli tooling, the Could a For tools there are duplicated in rust/ruby, we could provide an abstraction through a single command (rather than having two) and use a switch ├── pact-mock-service
├── pact-stub-service
├── pact-provider-verifier
├── pact_mock_server_cli
├── pact-stub-server
├── pact_verifier_cliBrain dumpThe pact-ruby-standalone project recently added the pact-plugin-cli to the bundle This weighs in at 12Mb and hugely inflates our bundle. This proposal suggests a couple of different packages
for any of the combinations above, they can have
augmentations, which seek to trim out as much as possible from the ruby runtime. Note:- the slim versions may not work and need throughly testing, cursory testing has been The overall aim is provide users with a single bundled distribution called pact-cli which contains every single pact executable so the users can get all the pact goodness at their This will have benefits for packaging with HomeBrew/Scoop/Choco and our own install script. In the future it would be nice to extend pact-plugin-cli which can discover and install plugins to discover all of the pact tooling (official and community provided) and provide a mechanism to install to a shared location such as PACT_HOME_DIR which would default to $HOME/.pact This pattern is already in use in the pact-plugin-cli Could we further this, so users only need the standalone in a single location, and the ffi libs in a single location, and our various client libraries to point to the relevant home folder, and not require the packages to contain the host libraries themselves. This may not be practical for some libs which need to build from source, but if the source was already on their machine, via our installer, maybe that makes it less of an issue. The tree of all tools would currently look like this ├── pact
├── pactflow
├── pact-broker
├── pact-message
├── pact-mock-service
├── pact-stub-service
├── pact-provider-verifier
├── pact_mock_server_cli
├── pact-stub-server
├── pact_verifier_cli
└── pact-plugin-cliUsers would be able to interact with the FFI by Package sizesFull Ruby Bundle - with pact-plugin-cliAs per todays release. Full Ruby (only) BundleTrimmed Ruby (only) BundleTRIM_PACKAGE_FULL=true bundle exec rake package Full Ruby Bundle + Pact Rust Tools
Ruby (only) + Pact-Ffi Gem (and pact_ffi libs) Bundle
Full Ruby Bundle + Pact Rust Tools + Pact-Ffi Gem (and pact_ffi libs)
Building & Testing.You can easily run through the testing by passing the same env vars. The following scenario will
You can run the smoke tests anyway, your standalone directory lives.
Example scenario
|
|
I've been testing it out against the main branch on my fork https://github.com/you54f/pact-ruby-standalone the build workflow takes workflow inputs that should be set to |
|
Regarding our native script installer. I've made some modifications to it so it will
Also updated our actions to provide access via the bin folder to all the bundles tooling, so it saves maintaining multiple actions. https://github.com/pactflow/actions it accepts env vars being set so the user can pin to particular versions if required, otherwise it will pick up latest. |
|
Regarding other package managers |
|
Thinking of a nice list of sources. Will incorporate and add yours Package ManagersWindows
MacOS
Linux
CI Systems
Other OS's
|
|
CircleCi Orb created by the community |
|
arch linux pact-cli (which is the pact-ruby-standalone) https://aur.archlinux.org/packages/pact-cli-bin now updated to include aarch64 for linux 🚀 however arch linux doesn't officially support aarch64 community maintained, I have emailed the reported author to reach out DockerfileFROM --platform=linux/amd64 greyltc/archlinux-aur:yay
RUN sudo -u ab -D~ bash -c 'yay -Syu --removemake --needed --noprogressbar --noconfirm pact-cli-bin'
ENTRYPOINT ["/bin/bash", "-c"]
CMD ["pact-mock-service --help"]Instructionsdocker build . -t archlinux-aur-pact-cli:latest -f Dockerfile.ArchLinux
docker run --platform=linux/amd64 --rm -it archlinux-aur-pact-cli:latestOutput>docker run --platform=linux/amd64 --rm -it archlinux-aur-pact-cli:latest 'pact-mock-service version'
3.11.2 |
It would be great to be able to install Pact CLI tool(s) using common packaging and distribution formats, e.g.
gem install pactbrew install pactcurl -sSL https://get.pact.io | bash -sstyle install (e.g. for RVMcurl -sSL https://get.rvm.io | bash -s stable --ruby)chocolatey install pactorInstall-package https://raw.githubusercontent.com/pact-standalone/releases/pact-1.0.0.configI would also propose that we only have 3 CLI tools: verifier, mock-service and the pact tool (containing broker commands, stubs etc.). The first two are for use by library implementations, where the latter could be installed by any user of Pact. I see this as being like a
traviscommand, where it is used for other useful stuff - e.g. bootstrapping projects.Thoughts?
The text was updated successfully, but these errors were encountered: