Welcome to YETI

Contributing, Development setup

It is strongly recommended to use PostgreSQL version 11. The easiest way to install it - is to use Debian Linux and follow official PostgreSQL instruction https://www.postgresql.org/download/linux/debian/

You need to install:

sudo apt-get install postgresql-11 postgresql-contrib-11 postgresql-11-prefix postgresql-11-pgq3
sudo apt-get install -t stretch-pgdg libpq-dev

In addition you need to compile or install from .deb package Yeti PostgreSQL extension https://github.com/yeti-switch/yeti-pg-ext

Then fork and clone yeti-web repository and run:

bundle install

Then create config/database.yml, example is database.yml.example. Notice this project uses two databases main "yeti" and second database "cdr"

And run command to create development database:

RAILS_ENV=development bundle exec rake db:create db:structure:load db:migrate
RAILS_ENV=development bundle exec rake db:second_base:create db:second_base:structure:load db:second_base:migrate
RAILS_ENV=development bundle exec rake db:seed

Then start rails server bundle exec rails s and login to http://localhost:3000/ with login admin and password 111111

Then prepare test database(do not use db:test:prepare).

RAILS_ENV=test bundle exec rake db:create db:structure:load db:migrate
RAILS_ENV=test bundle exec rake db:second_base:create db:second_base:structure:load db:second_base:migrate
RAILS_ENV=test bundle exec rake db:seed

This project has CDR-database, configured as SecondDatabase https://github.com/customink/secondbase And all commands should be run explicitly by calling "db:second_base:*" commands.

NOTICE: Test DB needs seeds, actually only PGQ seed.

And run tests:

bundle exec rspec

Migrations

When you run several migrations in a row, you may wish to stop at some point. In this case you should add stop_step method to the migration:

# example /db/migrate/20171105085529_one.rb
def change
  # do something
end

def stop_step
  true
end

In this case all migrations after this one will no be performed. To continue migration process you should run rake db:migrate command again.

If you do not want to migrate with stops, use env-variable IGNORE_STOPS=true

IGNORE_STOPS=true bundle exec rake db:migrate

Use Docker Postgres for development

For development purpouse it is convinient to use PostgreSQL from Docker image. Here is the instruction how to set it up-and-running:

• Install Docker(Ubuntu example)

  Install Docker on Ubuntu 18.10

• Run following commands in terminal from yeti-web projects directory

  sudo docker build -t yeti_postgres -f ci/pgsql.Dockerfile .
  

• Start the Postgres Server using docker image, with remapped port to 3010 and volume "yetiPgData" to persist data after docker container stops:

  sudo docker run -p 3010:5432 --volume yetiPgData:/var/lib/postgresql yeti_postgres
  

• Update config/database.yml with

  username: postgres
  password:
  port: 3010

• Initialize database with instructions described in Contributing, Development setup section(db:create, db:structure:load, etc.)