Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PaulRosset/previs
🎯 Testing your project locally in a clean environment.
https://github.com/PaulRosset/previs
ci continuous-testing devops devops-tools docker local test
Last synced: 3 months ago
JSON representation
🎯 Testing your project locally in a clean environment.
- Host: GitHub
- URL: https://github.com/PaulRosset/previs
- Owner: PaulRosset
- License: mit
- Created: 2018-09-05T11:12:16.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-08-23T09:11:25.000Z (about 5 years ago)
- Last Synced: 2024-06-27T21:22:13.458Z (4 months ago)
- Topics: ci, continuous-testing, devops, devops-tools, docker, local, test
- Language: Go
- Homepage:
- Size: 92.8 KB
- Stars: 325
- Watchers: 5
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Previs
> 🎯 Use Travis configuration to run stuff locally in a clean environment.
[](https://travis-ci.org/PaulRosset/previs)
[](https://build.snapcraft.io/user/PaulRosset/previs)
[](https://github.com/PaulRosset/previs/releases)
### Motivation
> Your very own local way of testing!
Previs is using the travis configuration mechanism to provide your own local service of continuous integration.
No more accidental error that trigger a fail build, no more plumbing on your git history.
But more than a local travis, it provides you a way of testing in a sandboxed environment and more...
Previs is also providing a way to run things in a clean environment with no side effect thank's to Docker.
**Previs** is still in active development.
### Installation
Previs is using docker at his heart, so of course you will need the docker daemon.
One of the simplest way to install it, it's by using the bash script:
```
$> curl -fsSL get.docker.com -o get-docker.sh
$> sh get-docker.sh
```
If you are on Mac, it's [here](https://docs.docker.com/docker-for-mac/install/#install-and-run-docker-for-mac)
You may have some trouble with permissions when attempting to run docker, if so, run the following command:
`sudo usermod -a -G docker $USER`
If the issue still persists, reboot your system.
#### [Snap packager](https://snapcraft.io/) for Linux users
**Previs** is snapped. He is using [snapcraft](https://docs.snapcraft.io/) which made very easy to install on linux system. The snapped software are updated automatically.
You have to run two commands and you will be ready to use **Previs**:
- `$> sudo apt install snapd`
- `$> sudo snap install previs`
As mentionned in [!8](https://github.com/PaulRosset/previs/pull/8), we let the possibility to still install the previous (0.4.1) version with the lighter image, so if you want the lighter image with less features:
- `$> sudo snap install --edge previs`
However if you want the latest release (0.5.0) with the official travis image:
- `$> sudo snap install --beta previs`
For others package manager [see](https://docs.snapcraft.io/core/install).
> Snap binary are located in `/snap/bin/`, make sure it is integrated in your $PATH env.
#### For others users
If you run an other operating system or you don't want to install it via snap, you can still install it "manually" by installing [Go](https://golang.org/doc/install) first, then by doing:
- `$> go get -v github.com/PaulRosset/previs`
Then make sure that your env variable $PATH contain the path where the go binary live.
Or you can still download the binary of release.
### How to use Previs
Previs is simple to use, he is using the travis mechanism to run 'things' in a clean environment.
However, since we are running things locally, we can't reproduce everythings that Travis is providing, so when the `.travis.yml` get too complex, you have the possibility to switch on a custom file named `.previs.yml`, then previs will take the configuration of the `.previs.yml`.
Once you are at the root of your repository where the `.travis.yml` or `.previs.yml` is, you can launch:
`$> previs [-p]`
The `-p` command indicate to previs to take the configuration of the `.previs.yml` instead of the `.travis.yml`.
**!IMPORTANT**
Go find out how Previs work right now and know more what you can do before using it, by checking out our [Wiki](https://github.com/PaulRosset/previs/wiki/Previs-Docs)
Previs understand a failed build when the program ran is returning other than the **0** exit code.
### Testing
Concerning the workflow of testing, rather than create unit tests on multiple call systems that already been tested especially docker calls, we instead run the program in real world use case to verify nothing broke and prevent regressions.
To understand it, you can check out the `.travis.yml` file that serve th is purpose.
On the other hand, for the configuration parsing of Travis mechanism, we have a package [travis](https://github.com/PaulRosset/previs/tree/master/travis) that is only doing this purpose and where some tests resides.
### Contribute
Any contributions is very welcomed, let's do something bigger and stronger together!
Points that will be improved:
- Improve the way of the docker images are wrote before build
- Adding support for more commands
- Clean when aborting via SIGNALs
### License
**MIT**
Paul Rosset