Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
app
Feb 15, 2021
bin
Oct 20, 2017

README.md

software.opensuse.org

Build StatusGitter chat

Ruby on Rails application powering https://software.opensuse.org

We hope you'll get involved! Read our Contributors' Guide for details.

Please note that deployments are currently not fully automated. So please note that commits and accepted pull-requests might not be visible on the production website software.opensuse.org for weeks or in exceptional cases for months until the deployment was triggered manually.

Installing dependencies in a (open)SUSE system

If you are an openSUSE user, you can configure your environment with:

zypper ref
zypper in ruby ruby-devel 'rubygem(bundler)' nodejs gcc gcc-c++ make libxml2-devel libxslt-devel

We recommend the usage of Ruby 2.5 or higher for the development (openSUSE Leap 15.2 and Tumbleweed satisfy this requirement). You can find more information about Ruby development and packaging on openSUSE distributions in the openSUSE Ruby page.

Running the application locally

Just for running it in development mode. If you are playing to deploy it in a server, please apply good Ruby on Rails practices (like generating your own keys for secrets.yml).

git clone https://github.com/openSUSE/software-o-o.git
cd software-o-o

bundle package
bundle exec rails s

Enjoy your software.opensuse.org clone at http://127.0.0.1:3000/

You can also run the unit tests locally using the command:

bundle exec rails test

and also the System Tests that will simulate user interaction using a headless browser:

bundle exec rails test:system

IMPORTANT: For the System Tests, the project is configured to use Firefox Headless Mode feature, available on:

  • Linux: Firefox 55 or higher;
  • Windows/Mac: Firefox 56 or higher.

See more here.

Instrumentation on development

By default in non-production environments, the prometheus instrumentation is disabled. You can enable it by passing INSTRUMENTATION=true environment variable when starting the application:

INSTRUMENTATION=true bundle exec rails s

When doing this, you need to start the prometheus_exporter process separately (otherwise you will observe a lot of warnings in the log as the instrumentation code will try to connect to the collector process). You can do so with this command:

bundle exec prometheus_exporter

After this the prometheus metrics will be exported under http://localhost:9394/metrics.

Updaing opensuse-theme-chameleon assets

git submodule init
git submodule update
make

After running the above commands, run RAILS_ENV=production rails assets:precompile and you should see the new assets.

Running the application in production

The application will take the following environment variables:

  • SECRET_KEY_BASE: See Encrypted Session Storage in Rails documentation.
  • API_USERNAME and API_PASSWORD: Credentials to the Open Build Service API end-point
    • These can be replaced with OPENSUSE_COOKIE if you have admin access to the Open Build Service instance.
  • RAILS_ENV

Puma will honor other variables too:

  • WEB_CONCURRENCY
  • RAILS_MAX_THREADS
  • PORT
  • RACK_ENV
  • SOFTWARE_O_O_RBTRACE

In production, prometheus instrumentation is enabled and prometheus_exporter process must be started.

Debugging

  • If SOFTWARE_O_O_RBTRACE is set, you can use rbtrace to debug the application.

Memcache

memcache should be running. It seems to be hardcoded in environments/production.rb to localhost:11211. This probably needs to be fixed, as the dalli gem, automatically uses MEMCACHE_SERVERS env variable or 127.0.0.1:11211 as default.

PaaS

If you plan to run the application on PaaS, make sure you set all the above variables correctly.

Official instance

The official instance is deployed using an rpm package. The rpm package bundles all the required gems.

There is a software_opensuse_org.service you can control via systemd.

The systemd service will read the variables described above from /etc/software_opensuse_org.conf in the form of an EnvironmentFile:

VAR1=value1
VAR2=value2
...

Development environment using Vagrant

There is also a Vagrant setup to create our development environment. All the tools needed for this are available for Linux, MacOS and Windows.

  1. Install Vagrant and docker. Both tools support Linux, MacOS and Windows.

  2. Clone this code repository:

    git clone --recurse-submodules git@github.com:openSUSE/software-o-o.git
    
  3. Build your Vagrant box:

    vagrant up
    
  4. Attach to your new development box:

    docker attach software_web
    
  5. Install gems:

    bundle install
    
  6. Start the app:

    rails server
    
  7. Enjoy your software.opensuse.org clone at http://127.0.0.1:3000/

If you exit the shell inside the vagrant box your development environment is stopped. Want to continue? Run vagrant up and docker attach software_web again. Happy hacking!