Vagrant

For a more thorough introduction to Vagrant, see https://fedoraproject.org/wiki/Vagrant.

An example Vagrantfile is provided as Vagrantfile.example. To use it, just copy it and install Vagrant:

$ cp dev/Vagrantfile.example Vagrantfile
$ sudo dnf install ansible libvirt vagrant-libvirt vagrant-sshfs vagrant-hostmanager
$ vagrant up

The default Vagrantfile forwards ports from the host to the guest, so you can interact with the application as if it were running on your host machine.

Docker Compose

Create the folder that will receive the projects, forks, docs, requests and tickets' git repo:

mkdir -p lcl/{repos,remotes,attachments,releases}

A docker compose environment is available to run pagure. First use the following command to build the containers.

$ docker-compose -f dev/docker-compose.yml build

Once all the containers are built, run the following command to start the containers.

$ docker-compose -f dev/docker-compose.yml up -d

Once all the containers have started, you can access pagure on http://localhost:5000

To stop the containers, run the following

$ docker-compose -f dev/docker-compose.yml stop

More information about docker-compose cli see https://docs.docker.com/compose/reference/.

• Running the unit-tests

To run the unit-tests, there is container available with all the dependencies needed.

Use the following command to build this container

$ docker build -t pagure-test -f dev/docker/test_environment dev/docker

Once the container is built, you can run the tests as follow

$ docker run -it --rm -v `pwd`:/code:z --workdir /code pagure-test ./runtests.sh

Manually

• Install the needed system libraries:

  sudo dnf install git python2-virtualenv libgit2-devel \
                   libjpeg-devel gcc libffi-devel redhat-rpm-config
  

  Note

  Do note the version of libgit2 that you install, for example in libgit2-0.23.4-1 you need to keep in mind the 0.23

  Note

  On Fedora 23 and earlier or on RHEL and derivative (CentOS, Scientific Linux) the package python2-virtualenv is named python-virtualenv

• Retrieve the sources:

  git clone https://pagure.io/pagure.git
  cd pagure
  

• Install dependencies

  • create the virtualenv:

    virtualenv pagure_env
    source ./pagure_env/bin/activate
    

  • Install the correct version of pygit2:

    pip install pygit2==<version of libgit2 found>.*
    

    So in our example:

    pip install pygit2==0.23.*
    

  • Install the rest of the dependencies:

    pip install -r requirements.txt
    

• Create the folder that will receive the projects, forks, docs, requests and tickets' git repo:

  mkdir -p lcl/{repos,remotes,attachments,releases}
  

• Copy and edit the alembic.ini file (especially the script_location key):

  cp files/alembic.ini .
  vim alembic.ini
  

• Set the script_location to alembic, ie: the folder where the revisions are stored, relative to the location of the alembic.ini file.

• Create the inital database scheme:

  python createdb.py --initial alembic.ini
  

• Start a worker, in one terminal:

  ./runworker.py
  

• Run the application, in another terminal:

  ./runserver.py
  

• To get some profiling information you can also run it as:

  ./runserver.py --profile
  

This will launch the application at http://127.0.0.1:5000

• To run unit-tests on pagure

  • Install the dependencies:

    pip install -r tests_requirements.txt
    

  • Run it:

    ./runtests.sh
    

    Note

    While testing for worker tasks, pagure uses celery in /usr/bin/ Celery then looks for eventlet (which we use for testing only) at system level and not in virtualenv. You will need to install eventlet outside of your virtualenv if you are using one.