MeeGo wiki - User contributions [en]

Quality/QA-tools/QAReports/Setting up the production environment

2011-07-01T06:26:35Z

Tomilaine:

= Overview =

Running and deploying QA Reports relies heavily on automated deployment scripts and version control repository. At high level, deployment process is following:

# Log in to your workstation and update QA Reports working tree
# Run Capistrano deployment script on your workstation
# Capistrano script connects to the production server and updates the deployment by
## Connecting to version control system from production server and updating the source code on the production server
## Running the migrations and updating the database schema on production server
## Restarting the application on production server

Capistrano enables you to automate also other administrative tasks like
# Rolling back to previous deployment
# Exporting data from production environment to your development environment

To achieve all the goodness, you should [[Quality/QA-tools/QAReports/Setting up the development environment|set up the development environment]] on your workstation before continuing.

= Setting up the production server =

This guide has been written for vanilla Ubuntu 10.04 installation. You need to be logged in to the production server and have sudo rights to continue.

== Install dependencies ==

<code>$ sudo aptitude install curl build-essential git-core openssh-server zlib1g-dev libssl-dev libreadline5-dev libcurl4-openssl-dev</code>

== Install Ruby ==

# Install [http://rvm.beginrescueend.com/ Ruby Version Manager] as root (to have system-wide install) <code>$ bash < <(curl -B http://rvm.beginrescueend.com/install/rvm)</code>
# Set up .bashrc as instructed by RVM installer: The whole content into an if section, and after that loading of RVM. Here's an example [http://gist.github.com/822216 .bashrc]
# Run: $ source ~/.bashrc
# Add your account and the deployment account to <code>rvm</code> group, e.g. <code>$ sudo adduser jakeskik rvm</code>
# Source your .bashrc to enable rvm <code>$ source ~/.bashrc</code>
# Install Ruby Enterprise Edition <code>$ rvm install ree</code>
# Set the default Ruby interpreter <code>$ rvm use --default ree</code>
# Install bundler <code>$ gem install rails bundler --no-ri --no-rdoc</code> #if you have proxy problem, plz refer to http://docs.rubygems.org/read/chapter/13#page51

Finally, enable rvm and Ruby Enterprise Edition to your deployment account, e.g. www-data

# Edit <code>/etc/passwd</code> and change <code>www-data</code>'s shell from <code>sh</code> to <code>bash</code>. You might want to change the home directory also from <code>/var/www</code> to e.g. <code>/home/www-data</code> as shown below <code>www-data:x:33:33:www-data:/home/www-data:/bin/bash</code>
# Enable RVM as shown below
<code>
$ sudo adduser www-data rvm
$ sudo -iu www-data
$ cp ~jakeskik/.profile .
$ cp ~jakeskik/.bashrc .
$ exit
</code>

== Install Apache and Phusion Passenger ==

<code>
$ sudo apt-get install apache2 apache2-prefork-dev libapr1-dev libaprutil1-dev
$ gem install passenger --no-ri --no-rdoc
$ rvmsudo passenger-install-apache2-module # Follow the on-screen instructions and edit apache.conf
$ sudo service apache2 restart
</code>

== Install MySQL ==

<code>
$ sudo apt-get install mysql-server libmysqlclient-dev
</code>

== Install Postfix ==

QA Reports sends email notifications for system administrators (you) in case the application throws an exception. To enable notifications, there needs to be a mail server configured on the production host.

<code>
$ sudo apt-get install postfix
</code>

The default configuration is fine and allows only delivery for emails originated from localhost. Just click through the installer.

== Test the environment ==

After installing the software, run a sanity check for the environment by creating a 'hello world' rails project and corresponding virtual host:

<code>
$ sudo -iu www-data
$ rails new hello
$ cd hello/public && pwd
/home/www-data/hello/public
$ exit
</code>

Write a following virtual host declaration to /etc/apache/sites-available/hello:

<code>
<VirtualHost *:80>
ServerName hello.qa.leonidasoy.fi
DocumentRoot /home/www-data/hello/public

<Directory /home/www-data/hello/public>
AllowOverride all
Options -MultiViews
</Directory>
</VirtualHost>
</code>

Enable the virtual host
<code>
$ sudo a2ensite hello
$ sudo service apache2 restart
</code>

Add the virtual host to <code>/etc/hosts</code> file:
<code>
127.0.0.1 hello.qa.leonidasoy.fi # Use the same domain as above
</code>

Now you should be able to access the 'hello world' project with a browser, e.g. lynx

<code>
$ lynx hello.qa.leonidasoy.fi
</code>

== Create a database for QA Reports ==

<code>
$ mysql -u root -p
mysql> create user 'qa-reports'@'localhost' identified by 'somepasswordofyourchoosing';
mysql> create database qa_reports_production character set 'utf8';
mysql> grant all privileges on qa_reports_production.* to 'qa-reports'@'localhost';
mysql> flush privileges;
mysql> exit
</code>

== Create virtual host for QA Reports ==

Write a following virtual host declaration to /etc/apache/sites-available/qa-reports:

<code>
<VirtualHost *:80>
ServerName qa-reports.qa.leonidasoy.fi
DocumentRoot /home/www-data/qa-reports.meego.com/current/public

<Directory /home/www-data/qa-reports.meego.com/current/public>
AllowOverride all
Options -MultiViews
</Directory>
</VirtualHost>
</code>

Enable the virtual host
<code>
$ sudo a2ensite qa-reports
$ sudo service apache2 restart # Don't mind the warning about missing dir,
# we'll deal with that one in a sec
</code>

= Deploying QA Reports =

QA Reports uses Capistrano to automate the deployments. The main benefit is to eliminate the risks of human errors and to enable easy and repeatable rollbacks. See [http://github.com/capistrano/capistrano/wiki Capistrano documentation] for the details.

Capistrano is run from your development environment, so you should be now on your workstation with working QA Reports development environment to continue.

== Enable public key authentication for your deployment account ==

Set up public key authentication:
# Generate yourself as SSH key pair if you don't have one: <tt>$ ssh-keygen</tt>
# Add your public key to <tt>authorized_keys</tt> file of your production environment user: <tt>$ ssh your.production.user@your.production.host 'mkdir .ssh; echo '`cat ~/.ssh/id_rsa.pub`' >> ~/.ssh/authorized_keys'</tt>
# Try logging in: <tt>ssh your.production.user@your.production.host</tt>

== Modify Capistrano scripts and deploy QA Reports ==

QA Reports uses following scripts to configure Capistrano
* <tt>config/deploy.rb</tt>
* <tt>config/deploy/staging.rb</tt>
* <tt>config/deploy/production.rb</tt>

You might want to review all the files, but usually it's enough to update only <tt>config/deploy/production.rb</tt> according to your needs (servers, deployment account, ssh options). You can also create new deployment environment just by copying the production.rb, to e.g. internal.rb and modify it.

Once the Capistrano is updated according to your needs, run
<code>
$ cap production deploy:setup # or cap internal deploy:setup, if you created a new deployment environment
</code>

Setup command creates the folder hierarchy and the symbolic links required by Capistrano. During the setup it requests following information
# Database host
# Database port
# Database name
# Database username
# Database password
# Should QA Reports send performance data to [http://newrelic.com NewRelic]? (Default: no)
# Registration token. This will be part of the registration url, e.g. <tt>foobar</tt> will make registration to be at url <tt>/users/foobar/register</tt>
# Email addresses for Exception Notifier

Once the setup is complete, the deployment is as easy as it gets
<code>
$ cap production deploy:migrations
</code>

You should now have QA Reports up&running. Congrats!

== Update QA Reports to a new version ==

# <code>git pull</code> (In case there's changes in the deployment scripts)
# <code>cap production deploy:migrations</code>
# Ta-da!

== Roll back to previous version ==

# <code>cap production deploy:rollback</code>
# Ta-da!

= Configuring data flow to QA Dashboard =

If you have set up [[Quality/QA-tools/QADashboard|QA Dashboard]] you will most likely want to enable data synchronization to it:

* Get authentication token to QA Dashboard
** This is currently a bit cumbersome: you need to open URI <tt>/user/token</tt> from your QA Dashboard server, save the file it offers to download and get the token from there.
* Configure QA Reports
** Insert correct QA Dashboard host and the authentication token to <tt>config/qa-dashboard_config.yml</tt>. The file is deployed with Capistrano task <tt>deploy:qadashboard:setup</tt> (which is run as part of <tt>deploy:setup</tt>). If you need to update the qa-dashboard config later, you can use the task <tt>deploy:qadashboard:update</tt>

If you need to export all your QA Reports data to your QA Dashboard you should use QA Reports' rake task. Once you have QA Reports up and running with correct QA Dashboard export setup, login to the production environment, go to folder <tt>your_installation/current</tt> and execute <tt>RAILS_ENV=production rake db:export_to_qadashboard</tt>.

Note: If you need to clear existing data from your QA Dashboard database, you will need to execute both <tt>db['qa-reports'].drop()</tt> and <tt>db['qa-reports'].dropIndexes()</tt> in the MongoDB database.

= Setting Up the Production Environment with nginx instead of Apache =

# Follow instructions above until "Install Apache and Passenger", then continue here from step 2.
# Install passenger: <tt>$ gem install passenger</tt>
# Install nginx: <tt>$ passenger-install-nginx-module</tt>
## Notice: the default location is under <tt>/opt</tt>. If you wish to install there, use <tt>rvmsudo</tt>. Notice however, that part of your <tt>~/.rvm</tt> contents will then belong to root and may cause gray hair later. I chose to install under <tt>~/nginx</tt>.
Edit nginx configuration <tt>installation_path/conf/nginx.conf</tt>:
## Comment out section <tt>location / { ... }</tt>
## Add lines:
### <tt>passenger_enabled on;</tt>
### <tt>root /home/your_prod_env_user/qa-reports.meego.com/current/public;</tt>
# Start nginx: <tt>$ sudo /installation_path/sbin/nginx</tt>
# Continue with the guide above from "Deploying QA Reports"

Quality/QA-tools/QADashboard/Setting up the production environment

2011-06-30T21:08:52Z

Tomilaine:

= Overview =

Running and deploying QA Dashboard relies heavily on automated deployment scripts and version control repository. At high level, deployment process is following:

# Log in to your workstation and update QA Dashboard working tree
# Run Capistrano deployment script on your workstation
# Capistrano script connects to the production server and updates the deployment by
## Connecting to version control system from production server and updating the source code on the production server
## Installing node package dependencies
## Restarting the application on production server

= Setting up the local environment for deployments =

QA Dashboard uses Capistrano to automate the deployments. The main benefit is to eliminate the risks of human errors and to enable easy and repeatable rollbacks. See [http://github.com/capistrano/capistrano/wiki Capistrano documentation] for the details

== Install development environment ==

You should first [http://wiki.meego.com/Quality/QA-tools/QADashboard/Setting_up_the_development_environment set up the development environment] on your workstation before continuing.
Capistrano is run from your development environment

== Installing Capistrano ==

Capistrano requires Ruby. If you do not have Ruby installed please follow the "Install Ruby" instructions [http://wiki.meego.com/Quality/QA-tools/QAReports/Setting_up_the_development_environment here].

<tt>$ gem install capistrano</tt>

= Setting up the production server =

== Install dependencies ==

The same dependencies are needed in the production server as in development environment.
Follow the instructions in [[Quality/QA-tools/QADashboard/Setting_up_the_development_environment]] to:
# Install Node.js
# Install Node Package Manager
# Install mongodb

== Create virtual host for QA Dashboard ==
(example using nginx)

Write a following virtual host declaration to /etc/nginx/sites-available/qa-dashboard

<code>
server {
listen 80;
server_name qa-dashboard.qa.leonidasoy.fi;
location / {
proxy_pass http://localhost:3030;
proxy_set_header Host $host;
proxy_set_header X-Forwarded-Host $host;
proxy_set_header X-Forwarded-Server $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Real-IP $remote_addr;
}
}
</code>

Restart nginx
<code>
sudo service nginx restart
</code>

= Deploying QA Dashboard =

== Enable public key authentication for your deployment account ==

Set up public key authentication:
# Generate yourself as SSH key pair if you don't have one: <tt>$ ssh-keygen</tt>
# Add your public key to <tt>authorized_keys</tt> file of your production environment user: <tt>$ ssh your.production.user@your.production.host 'mkdir .ssh; echo '`cat ~/.ssh/id_rsa.pub`' >> ~/.ssh/authorized_keys'</tt>
# Try logging in: <tt>ssh your.production.user@your.production.host</tt>

== Modify settings ==

QA Dashboard authentication settings are defined in <tt>settings.json</tt> that is deployed with Capistrano.

=== LDAP Authentication ===

TODO

=== MySQL Authentication ===

TODO

== Modify Capistrano scripts and setup deployment ==

QA Dashboard uses following scripts to configure Capistrano
* <tt>config/deploy.rb</tt>
* <tt>config/deploy/staging.rb</tt>
* <tt>config/deploy/production.rb</tt>

You might want to review all the files, but usually it's enough to update only <tt>config/deploy/production.rb</tt> according to your needs (servers, deployment account, ssh options). You can also create new deployment environment just by copying the production.rb, to e.g. internal.rb and modify it.

When you deploy for first time you need to run setup command, which creates creates the folder hierarchy and the symbolic links required by Capistrano. 
Once the Capistrano is updated according to your needs you need to run setup command, which creates creates the folder hierarchy and the symbolic links required by Capistrano. After that the server can be started.
<code>
$ cap production deploy:setup # or cap internal deploy:setup, if you created a new deployment environment
$ cap production deploy:start # starts the server
</code>

== Deploying QA Dashboard ==

Once the setup is complete, the deployment is as easy as it gets
<code>
$ cap production deploy
</code>

== Setting up the data flow ==

QA Dashboard naturally needs data to be shown. This data usually comes from [[Quality/QA-tools/QAReports|QA Reports]] and Bugzilla.

=== Getting data from QA Reports ===
Instructions for setting up the data synchronization is described in [[Quality/QA-tools/QAReports/Setting_up_the_production_environment#Configuring_data_flow_to_QA_Dashboard|QA Reports installation guide]].

=== Getting data from Bugzilla ===

QA Dashboard environment includes a script which pulls data from bugzilla and pushes it to qa-dashboard.

* Usage:
<code>
$ cd export/bugzilla
$ bundle install
$ vi bugzilla_config.yml #use your editor of choice to define bugzilla settings
$ vi qa-dashboard_config.yml #and qa-dashboard settings
$ ruby bugzilla_export.rb start
</code>

* The script starts a background process and writes logs to <tt>bugzilla_exportd.output</tt>
* If you need to stop the script, it can be done with <tt>ruby bugzilla_export.rb stop</tt>

Quality/QA-tools/QADashboard

2011-06-22T11:01:58Z

Tomilaine:

= QA Dashboard =

[http://qa-dashboard.leonidasoy.fi/ MeeGo QA Dashboard] is an application for viewing the quality at a glance. It uses various types of widgets to draw graphs and metrics to highlight interesting quality statistics.

== Environments ==
* [http://qa-dashboard.qa.leonidasoy.fi/ Staging environment - http://qa-dashboard.qa.leonidasoy.fi/]

== Source code ==
* [http://meego.gitorious.org/meego-quality-assurance/qa-dashboard Source code in Gitorious]

== Administration guide ==
* [[Quality/QA-tools/QADashboard/Setting_up_the_production_environment|Setting up the production environment]]

== Developer information ==
* [[Quality/QA-tools/QADashboard/Setting_up_the_development_environment|Setting up the development environment]]

== Contact information ==

QA Dashboard is developed by [[Quality/QA-tools | QA tools team]]. You can contact us via the following channels:
* [http://webchat.freenode.net/?channels=meego-qa #meego-qa IRC channel on irc.freenode.net]
* [http://bugs.meego.com/enter_bug.cgi?product=MeeGo%20Quality%20Assurance&component=qa-dashboard File new bugs or improvement ideas to Bugzilla]
* [http://bugs.meego.com/buglist.cgi?bug_status=NEW&bug_status=NEEDINFO&bug_status=INDEFINITION&bug_status=ASSIGNED&bug_status=ACCEPTED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=WAITING&bug_status=REOPENED&bug_status=RESOLVED&bug_status=RELEASED&bug_status=VERIFIED&component=qa-dashboard&query_format=advanced&order=priority%2Cbug_severity%2Cchangeddate%2Cbug_status%2Cassigned_to%2Cbug_id&query_based_on= Leave a comment or vote the items in our backlog]
* [http://lists.meego.com/listinfo/meego-qa meego-qa@lists.meego.com mailing list]

Quality/QA-tools/QADashboard/Setting up the development environment

2011-06-01T11:51:36Z

Tomilaine:

==Introduction==

QA Dashboard is a [http://nodejs.org/ Node.js] application. It is written in [http://jashkenas.github.com/coffee-script/ coffee-script] and uses [http://www.mongodb.org/ mongodb] database. You need to install some awesome open source tools to get the development environment up and running.

==Install Node.js==
(uses v0.4.5 stable package)
#<tt> $ wget http://nodejs.org/dist/node-v0.4.5.tar.gz</tt>
#<tt> $ gunzip node-v0.4.5.tar.gz </tt>
#<tt> $ tar -xf node-v0.4.5.tar</tt>
#<tt> $ cd node-v0.4.5</tt>
#<tt> $ ./configure</tt>
#<tt> $ make</tt>
#<tt> $ sudo make install</tt>

==Install Node Package Manager==
(uses v1.0.1rc7 stable branch)
#<tt>$ git clone https://github.com/isaacs/npm.git</tt>
#<tt>$ cd npm</tt>
#<tt>$ git checkout v1.0.1rc7</tt>
#<tt>$ sudo make install</tt>

If your environment does not allow git protocol, make install will fail because of fetching the submodules. This can be fixed by changing the submodule URLs:
#<tt>$ git config submodule.node_modules/abbrev.url https://github.com/isaacs/abbrev-js.git</tt>
#<tt>$ git config submodule.node_modules/nopt.url https://github.com/isaacs/nopt.git</tt>
#<tt>$ git config submodule.node_modules/semver.url https://github.com/isaacs/node-semver.git</tt>

==Install mongodb==
#<tt> $ sudo apt-get install mongodb</tt>

==Set up QA Dashboard==
Get the source and install dependencies
#<tt> $ git clone git://gitorious.org/meego-quality-assurance/qa-dashboard.git</tt>
#<tt> $ cd qa-dashboard</tt>
#<tt> $ npm install</tt>

==Run the tests and start the server==
#Run unit tests:<tt> $ ./run-nodeunit.sh</tt>
#Start the server:<tt> $ ./run-server.sh</tt>
#Browse to http://localhost:3030

The server will start in development mode using node-supervisor, which watches for code changes and restarts the server accordingly.

Quality/QA-tools/CrashReports

2011-06-01T11:50:34Z

Tomilaine:

= Crash Reports =

[[File:Meego crash reports.png|right|415px]]

== Developer information ==
* [[Quality/QA-tools/CrashReports/Setting_up_the_development_environment|Setting up the development environment]]

== User Documentation ==

* [[Quality/QA-tools/CrashReports/API|API Documentation]]

Quality/QA-tools/CrashReports/Setting up the development environment

2011-06-01T11:47:37Z

Tomilaine:

==Introduction==

Crash Reports is a [http://nodejs.org/ Node.js] application. It is written in [http://jashkenas.github.com/coffee-script/ coffee-script] and uses [http://www.mongodb.org/ mongodb] database. You need to install some awesome open source tools to get the development environment up and running.

==Install Node.js==
(uses v0.4.5 stable package)
#<tt> $ wget http://nodejs.org/dist/node-v0.4.5.tar.gz</tt>
#<tt> $ gunzip node-v0.4.5.tar.gz </tt>
#<tt> $ tar -xf node-v0.4.5.tar</tt>
#<tt> $ cd node-v0.4.5</tt>
#<tt> $ ./configure</tt>
#<tt> $ make</tt>
#<tt> $ sudo make install</tt>

==Install Node Package Manager==
(uses v1.0.1rc7 stable branch)
#<tt>$ git clone https://github.com/isaacs/npm.git</tt>
#<tt>$ cd npm</tt>
#<tt>$ git checkout v1.0.1rc7</tt>
#<tt>$ sudo make install</tt>

If your environment does not allow git protocol, make install will fail because of fetching the submodules. This can be fixed by changing the submodule URLs:
#<tt>$ git config submodule.node_modules/abbrev.url https://github.com/isaacs/abbrev-js.git</tt>
#<tt>$ git config submodule.node_modules/nopt.url https://github.com/isaacs/nopt.git</tt>
#<tt>$ git config submodule.node_modules/semver.url https://github.com/isaacs/node-semver.git</tt>

==Install mongodb==
#<tt> $ sudo apt-get install mongodb</tt>

==Set up Crash Reports==
Get the source and install dependencies
#<tt> $ git clone git://gitorious.org/meego-quality-assurance/crash-reports.git</tt>
#<tt> $ cd crash-reports</tt>
#<tt> $ npm install</tt>

==Start the server==
#Start the server:<tt> $ ./run-server.sh</tt>
#Browse to http://localhost:3040 to verify that server is running

The server will start in development mode using node-supervisor, which watches for code changes and restarts the server accordingly.

Quality/QA-tools/CrashReports/Setting up the development environment

2011-06-01T11:46:34Z

Tomilaine:

==Introduction==

Crash Reports is a [http://nodejs.org/ Node.js] application. It is written in [http://jashkenas.github.com/coffee-script/ coffee-script] and uses [http://www.mongodb.org/ mongodb] database. You need to install some awesome open source tools to get the development environment up and running.

==Install Node.js==
(uses v0.4.5 stable package)
#<tt> $ wget http://nodejs.org/dist/node-v0.4.5.tar.gz</tt>
#<tt> $ gunzip node-v0.4.5.tar.gz </tt>
#<tt> $ tar -xf node-v0.4.5.tar</tt>
#<tt> $ cd node-v0.4.5</tt>
#<tt> $ ./configure</tt>
#<tt> $ make</tt>
#<tt> $ sudo make install</tt>

==Install Node Package Manager==
(uses v1.0.1rc7 stable branch)
#<tt>$ git clone https://github.com/isaacs/npm.git</tt>
#<tt>$ cd npm</tt>
#<tt>$ git checkout v1.0.1rc7</tt>
#<tt>$ sudo make install</tt>

If your environment does not allow git protocol, make install will fail because of fetching the submodules. This can be fixed by changing the submodule URLs:
#<tt>$ git config submodule.node_modules/abbrev.url https://github.com/isaacs/abbrev-js.git</tt>
#<tt>$ git config submodule.node_modules/nopt.url https://github.com/isaacs/nopt.git</tt>
#<tt>$ git config submodule.node_modules/semver.url https://github.com/isaacs/node-semver.git</tt>

==Install mongodb==
#<tt> $ sudo apt-get install mongodb</tt>

==Set up Crash Reports==
Get the source and install dependencies
#<tt> $ git clone git://gitorious.org/meego-quality-assurance/crash-reports.git</tt>
#<tt> $ cd crash-reports</tt>
#<tt> $ npm install</tt>

==Start the server==
#Start the server:<tt> $ ./run-server.sh</tt>

By default the server can be reached at http://localhost:3040
The server will start in development mode using node-supervisor, which watches for code changes and restarts the server accordingly.

Quality/QA-tools/CrashReports/Setting up the development environment

2011-06-01T11:45:58Z

Tomilaine: Created page with "==Introduction== Crash Reports is a [http://nodejs.org/ Node.js] application. It is written in [http://jashkenas.github.com/coffee-script/ coffee-script] and uses [http://www.mo..."

==Introduction==

Crash Reports is a [http://nodejs.org/ Node.js] application. It is written in [http://jashkenas.github.com/coffee-script/ coffee-script] and uses [http://www.mongodb.org/ mongodb] database. You need to install some awesome open source tools to get the development environment up and running.

==Install Node.js==
(uses v0.4.5 stable package)
#<tt> $ wget http://nodejs.org/dist/node-v0.4.5.tar.gz</tt>
#<tt> $ gunzip node-v0.4.5.tar.gz </tt>
#<tt> $ tar -xf node-v0.4.5.tar</tt>
#<tt> $ cd node-v0.4.5</tt>
#<tt> $ ./configure</tt>
#<tt> $ make</tt>
#<tt> $ sudo make install</tt>

==Install Node Package Manager==
(uses v1.0.1rc7 stable branch)
#<tt>$ git clone https://github.com/isaacs/npm.git</tt>
#<tt>$ cd npm</tt>
#<tt>$ git checkout v1.0.1rc7</tt>
#<tt>$ sudo make install</tt>

If your environment does not allow git protocol, make install will fail because of fetching the submodules. This can be fixed by changing the submodule URLs:
#<tt>$ git config submodule.node_modules/abbrev.url https://github.com/isaacs/abbrev-js.git</tt>
#<tt>$ git config submodule.node_modules/nopt.url https://github.com/isaacs/nopt.git</tt>
#<tt>$ git config submodule.node_modules/semver.url https://github.com/isaacs/node-semver.git</tt>

==Install mongodb==
#<tt> $ sudo apt-get install mongodb</tt>

==Set up Crash Reports==
Get the source and install dependencies
#<tt> $ git clone git://gitorious.org/meego-quality-assurance/crash-reports.git</tt>
#<tt> $ cd crash-reports</tt>
#<tt> $ npm install</tt>

==Start the server==
#Start the server:<tt> $ ./run-server.sh</tt>
#By default the server can be reached at http://localhost:3040

The server will start in development mode using node-supervisor, which watches for code changes and restarts the server accordingly.

Quality/QA-tools/CrashReports/API

2011-05-17T13:58:18Z

Tomilaine:

== /api/import ==
Description: Import crash report 
Method: POST [encoding multipart/form-data]

Parameters:
{| border="1" cellpadding="5" cellspacing="0"
|-
! Parameter name
! Description
! Values
|-
| auth-token
| Personal authentication token
| 123456789ABCDE
|-
| release
| Release version
| 1.0, 1.1, 1.2
|-
| profile
| MeeGo profile
| Optional. Core, Handset, Tablet, Netbook, IVI
|-
| product
| Product name
| Ia-Russellville, N900, Pinetrail etc
|-
| build
| Build name
| e.g. 2011.14, 2011.15 etc
|-
| id
| Unique identifier for the crash, e.g. MD5(core file)
|
|-
| mac
| MD5(device's MAC address)
| Optional
|-
| imei
| MD5(device's IMEI address)
| Optional
|-
| core
| Coredump as an attachment
|
|-
| rich-core
| Rich core as an attachment
|
|-
| stack-trace
| Stack trace as an attachment
|
|-
| attachment.[1..n]
| Other files to be attached with the report: Screenshots, logs etc
| Optional
|}

The input can contain multiple ''attachment'' files. An unique field name have to be given for each file. Unique file names are created by giving a sequence number for each file starting from number 1, for example "attachment.1", "attachment.2" etc.

Because multiple files can be uploaded, HTTP POST with "[http://tools.ietf.org/html/rfc2388 multipart/form-encoding]" is used.

An example using [http://curl.haxx.se/Curl Curl] for testing the API:

<code>curl -F "core=@filename.core" -F "rich-core=@filename.rcore" -F "stack-trace=@trace.txt" -F "id=1234567890ABCDEF" -F "auth-token=123456" -F "attachment.1=@test.jpg" -F "release="1.2" -F "product=N900" -F "build=2011.20" http://crash-reports.qa.leonidasoy.fi/api/import</code>

The operation results status code in [http://en.wikipedia.org/wiki/JSON JSON] format. If the operation proceeds successfully, key value pair "ok" = 1 is returned with a link to the created report.

<code>{"ok":"1", "url":"http://crash-reports.qa.leonidasoy.fi/1234657890ABCDEF"}</code>

In case of error, ''ok'' values is 0, and an additional field ''errors'' describing the problem is returned

<code>{"ok":"0","errors":"unknown attribute: foobar"}</code>

Quality/QA-tools/CrashReports/API

2011-05-17T13:52:02Z

Tomilaine:

== /api/import ==
Description: Import crash report 
Method: POST [encoding multipart/form-data]

Parameters:
{| border="1" cellpadding="5" cellspacing="0"
|-
! Parameter name
! Description
! Values
|-
| auth-token
| Personal authentication token
| 123456789ABCDE
|-
| release
| Release version
| 1.0, 1.1, 1.2
|-
| profile
| MeeGo profile
| Optional. Core, Handset, Tablet, Netbook, IVI
|-
| product
| Product name
| Ia-Russellville, N900, Pinetrail etc
|-
| build
| Build name
| e.g. 2011.14, 2011.15 etc
|-
| id
| Unique identifier for the crash, e.g. MD5(core file)
|
|-
| mac
| MD5(device's MAC address)
| Optional
|-
| imei
| MD5(device's IMEI address)
| Optional
|-
| core
| Coredump as an attachment
|
|-
| rich-core
| Rich core as an attachment
|
|-
| stack-trace
| Stack trace as an attachment
|
|-
| attachment.[1..n]
| Other files to be attached with the report: Screenshots, logs etc
| Optional
|}

The input can contain multiple ''attachment'' files. An unique field name have to be given for each file. Unique file names are created by giving a sequence number for each file starting from number 1, for example "attachment.1", "attachment.2" etc.

Because multiple files can be uploaded, HTTP POST with "[http://tools.ietf.org/html/rfc2388 multipart/form-encoding]" is used.

An example using [http://curl.haxx.se/Curl Curl] for testing the API:

<code>curl -F "core=@filename.core" -F "rich-core=@filename.rcore" -F "stack-trace=@trace.txt" -F "id=1234567890ABCDEF" -F "auth-token=123456" -F "attachment.1=@test.jpg" -F "release="1.2" -F "product=N900" -F "build=2011.20" http://crash-reports.leonidasoy.fi/api/import</code>

The operation results status code in [http://en.wikipedia.org/wiki/JSON JSON] format. If the operation proceeds successfully, key value pair "ok" = 1 is returned with a link to the created report.

<code>{"ok":"1", "url":"http://crash-reports.leonidasoy.fi/1234657890ABCDEF"}</code>

In case of error, ''ok'' values is 0, and an additional field ''errors'' describing the problem is returned

<code>{"ok":"0","errors":"unknown attribute: foobar"}</code>

Quality/QA-tools/QADashboard/Setting up the production environment

2011-04-19T14:08:54Z

Tomilaine:

= Overview =

Running and deploying QA Dashboard relies heavily on automated deployment scripts and version control repository. At high level, deployment process is following:

# Log in to your workstation and update QA Dashboard working tree
# Run Capistrano deployment script on your workstation
# Capistrano script connects to the production server and updates the deployment by
## Connecting to version control system from production server and updating the source code on the production server
## Installing node package dependencies
## Restarting the application on production server

= Setting up the local environment for deployments =

QA Dashboard uses Capistrano to automate the deployments. The main benefit is to eliminate the risks of human errors and to enable easy and repeatable rollbacks. See [http://github.com/capistrano/capistrano/wiki Capistrano documentation] for the details

== Install development environment ==

You should first [http://wiki.meego.com/Quality/QA-tools/QADashboard/Setting_up_the_development_environment set up the development environment] on your workstation before continuing.
Capistrano is run from your development environment

== Installing Capistrano ==

Capistrano requires Ruby. If you do not have Ruby installed please follow the "Install Ruby" instructions [http://wiki.meego.com/Quality/QA-tools/QAReports/Setting_up_the_development_environment here].

<tt>$ gem install capistrano</tt>

= Setting up the production server =

== Install dependencies ==

The same dependencies are needed in the production server as in development environment.
Follow the instructions in [[Quality/QA-tools/QAReports/Setting_up_the_development_environment]] to:
# Install Node.js
# Install Node Package Manager
# Install mongodb

== Create virtual host for QA Dashboard ==
(example using nginx)

Write a following virtual host declaration to /etc/nginx/sites-available/qa-dashboard

<code>
server {
listen 80;
server_name qa-dashboard.qa.leonidasoy.fi;
location / {
proxy_pass http://localhost:3030;
proxy_set_header Host $host;
proxy_set_header X-Forwarded-Host $host;
proxy_set_header X-Forwarded-Server $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Real-IP $remote_addr;
}
}
</code>

Restart nginx
<code>
sudo service nginx restart
</code>

= Deploying QA Dashboard =

== Enable public key authentication for your deployment account ==

Set up public key authentication:
# Generate yourself as SSH key pair if you don't have one: <tt>$ ssh-keygen</tt>
# Add your public key to <tt>authorized_keys</tt> file of your production environment user: <tt>$ ssh your.production.user@your.production.host 'mkdir .ssh; echo '`cat ~/.ssh/id_rsa.pub`' >> ~/.ssh/authorized_keys'</tt>
# Try logging in: <tt>ssh your.production.user@your.production.host</tt>

== Modify Capistrano scripts and setup deployment ==

QA Dashboard uses following scripts to configure Capistrano
* <tt>config/deploy.rb</tt>
* <tt>config/deploy/staging.rb</tt>
* <tt>config/deploy/production.rb</tt>

You might want to review all the files, but usually it's enough to update only <tt>config/deploy/production.rb</tt> according to your needs (servers, deployment account, ssh options). You can also create new deployment environment just by copying the production.rb, to e.g. internal.rb and modify it.

When you deploy for first time you need to run setup command, which creates creates the folder hierarchy and the symbolic links required by Capistrano. 
Once the Capistrano is updated according to your needs you need to run setup command, which creates creates the folder hierarchy and the symbolic links required by Capistrano. After that the server can be started.
<code>
$ cap production deploy:setup # or cap internal deploy:setup, if you created a new deployment environment
$ cap production deploy:start # starts the server
</code>

== Deploying QA Dashboard ==

Once the setup is complete, the deployment is as easy as it gets
<code>
$ cap production deploy
</code>

Quality/QA-tools/QADashboard/Setting up the production environment

2011-04-19T13:28:14Z

Tomilaine:

= Overview =

Running and deploying QA Dashboard relies heavily on automated deployment scripts and version control repository. At high level, deployment process is following:

# Log in to your workstation and update QA Dashboard working tree
# Run Capistrano deployment script on your workstation
# Capistrano script connects to the production server and updates the deployment by
## Connecting to version control system from production server and updating the source code on the production server
## Installing node package dependencies
## Restarting the application on production server

= Setting up the local environment for deployments =

QA Dashboard uses Capistrano to automate the deployments. The main benefit is to eliminate the risks of human errors and to enable easy and repeatable rollbacks. See [http://github.com/capistrano/capistrano/wiki Capistrano documentation] for the details

== Install development environment ==

You should first [http://wiki.meego.com/Quality/QA-tools/QADashboard/Setting_up_the_development_environment set up the development environment] on your workstation before continuing.
Capistrano is run from your development environment

== Installing Capistrano ==

Capistrano requires Ruby. If you do not have Ruby installed please follow the "Install Ruby" instructions [http://wiki.meego.com/Quality/QA-tools/QAReports/Setting_up_the_development_environment here].

<tt>$ gem install capistrano</tt>

= Setting up the production server =

== Install dependencies ==

The same dependencies are needed in the production server as in development environment.
Follow the instructions in [[Quality/QA-tools/QAReports/Setting_up_the_development_environment]] to:
# Install Node.js
# Install Node Package Manager
# Install mongodb

== Create virtual host for QA Dashboard ==
(example using nginx)

Write a following virtual host declaration to /etc/nginx/sites-available/qa-dashboard

<code>
server {
listen 80;
server_name qa-dashboard.qa.leonidasoy.fi;
location / {
proxy_pass http://localhost:3030;
proxy_set_header Host $host;
proxy_set_header X-Forwarded-Host $host;
proxy_set_header X-Forwarded-Server $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Real-IP $remote_addr;
}
}
</code>

= Deploying QA Dashboard =

== Enable public key authentication for your deployment account ==

Set up public key authentication:
# Generate yourself as SSH key pair if you don't have one: <tt>$ ssh-keygen</tt>
# Add your public key to <tt>authorized_keys</tt> file of your production environment user: <tt>$ ssh your.production.user@your.production.host 'mkdir .ssh; echo '`cat ~/.ssh/id_rsa.pub`' >> ~/.ssh/authorized_keys'</tt>
# Try logging in: <tt>ssh your.production.user@your.production.host</tt>

== Modify Capistrano scripts and setup deployment ==

QA Dashboard uses following scripts to configure Capistrano
* <tt>config/deploy.rb</tt>
* <tt>config/deploy/staging.rb</tt>
* <tt>config/deploy/production.rb</tt>

You might want to review all the files, but usually it's enough to update only <tt>config/deploy/production.rb</tt> according to your needs (servers, deployment account, ssh options). You can also create new deployment environment just by copying the production.rb, to e.g. internal.rb and modify it.

When you deploy for first time you need to run setup command, which creates creates the folder hierarchy and the symbolic links required by Capistrano. 
Once the Capistrano is updated according to your needs you need to run setup command, which creates creates the folder hierarchy and the symbolic links required by Capistrano. After that the server can be started.
<code>
$ cap production deploy:setup # or cap internal deploy:setup, if you created a new deployment environment
$ cap production deploy:start # starts the server
</code>

== Deploying QA Dashboard ==

Once the setup is complete, the deployment is as easy as it gets
<code>
$ cap production deploy
</code>

Quality/QA-tools/QADashboard/Setting up the production environment

2011-04-19T13:23:18Z

Tomilaine:

= Overview =

Running and deploying QA Dashboard relies heavily on automated deployment scripts and version control repository. At high level, deployment process is following:

# Log in to your workstation and update QA Dashboard working tree
# Run Capistrano deployment script on your workstation
# Capistrano script connects to the production server and updates the deployment by
## Connecting to version control system from production server and updating the source code on the production server
## Installing node package dependencies
## Restarting the application on production server

= Setting up the local environment for deployments =

QA Dashboard uses Capistrano to automate the deployments. The main benefit is to eliminate the risks of human errors and to enable easy and repeatable rollbacks. See [http://github.com/capistrano/capistrano/wiki Capistrano documentation] for the details

== Install development environment ==

You should first [http://wiki.meego.com/Quality/QA-tools/QADashboard/Setting_up_the_development_environment set up the development environment] on your workstation before continuing.
Capistrano is run from your development environment

== Installing Capistrano ==

Capistrano requires Ruby. If you do not have Ruby installed please follow the "Install Ruby" instructions [http://wiki.meego.com/Quality/QA-tools/QAReports/Setting_up_the_development_environment here].

<tt>$ gem install capistrano</tt>

= Setting up the production server =

== Install dependencies ==

The same installations are needed in the production server as in development environment.
Follow the instructions in [[Quality/QA-tools/QAReports/Setting_up_the_development_environment]] to:
# Install Node.js
# Install Node Package Manager
# Install mongodb

== Create virtual host for QA Dashboard ==
(example using nginx)

Write a following virtual host declaration to /etc/nginx/sites-available/qa-dashboard

<code>
server {
listen 80;
server_name qa-dashboard.qa.leonidasoy.fi;
location / {
proxy_pass http://localhost:3030;
proxy_set_header Host $host;
proxy_set_header X-Forwarded-Host $host;
proxy_set_header X-Forwarded-Server $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Real-IP $remote_addr;
}
}
</code>

= Deploying QA Dashboard =

== Enable public key authentication for your deployment account ==

Set up public key authentication:
# Generate yourself as SSH key pair if you don't have one: <tt>$ ssh-keygen</tt>
# Add your public key to <tt>authorized_keys</tt> file of your production environment user: <tt>$ ssh your.production.user@your.production.host 'mkdir .ssh; echo '`cat ~/.ssh/id_rsa.pub`' >> ~/.ssh/authorized_keys'</tt>
# Try logging in: <tt>ssh your.production.user@your.production.host</tt>

== Modify Capistrano scripts and setup deployment ==

QA Dashboard uses following scripts to configure Capistrano
* <tt>config/deploy.rb</tt>
* <tt>config/deploy/staging.rb</tt>
* <tt>config/deploy/production.rb</tt>

You might want to review all the files, but usually it's enough to update only <tt>config/deploy/production.rb</tt> according to your needs (servers, deployment account, ssh options). You can also create new deployment environment just by copying the production.rb, to e.g. internal.rb and modify it.

When you deploy for first time you need to run setup command, which creates creates the folder hierarchy and the symbolic links required by Capistrano. 
Once the Capistrano is updated according to your needs you need to run setup command, which creates creates the folder hierarchy and the symbolic links required by Capistrano. After that the server can be started.
<code>
$ cap production deploy:setup # or cap internal deploy:setup, if you created a new deployment environment
$ cap production deploy:start # starts the server
</code>

== Deploying QA Dashboard ==

Once the setup is complete, the deployment is as easy as it gets
<code>
$ cap production deploy
</code>

Quality/QA-tools/QADashboard/Setting up the production environment

2011-04-19T11:39:14Z

Tomilaine: Created page with "= Overview = Running and deploying QA Dashboard relies heavily on automated deployment scripts and version control repository. At high level, deployment process is following: #..."

Quality/QA-tools/QADashboard/Setting up the development environment

2011-04-19T11:35:50Z

Tomilaine:

==Introduction==

QA Dashboard is a [http://nodejs.org/ Node.js] application. It is written in [http://jashkenas.github.com/coffee-script/ coffee-script] and uses [http://www.mongodb.org/ mongodb] database. You need to install some awesome open source tools to get the development environment up and running.

==Install Node.js==
(uses v0.4.5 stable package)
#<tt> $ wget http://nodejs.org/dist/node-v0.4.5.tar.gz</tt>
#<tt> $ gunzip node-v0.4.5.tar.gz </tt>
#<tt> $ tar -xf node-v0.4.5.tar</tt>
#<tt> $ cd node-v0.4.5</tt>
#<tt> $ ./configure</tt>
#<tt> $ make</tt>
#<tt> $ sudo make install</tt>

==Install Node Package Manager==
(uses v1.0.1rc7 stable branch)
#<tt>$ git clone https://github.com/isaacs/npm.git</tt>
#<tt>$ cd npm</tt>
#<tt>$ git checkout v1.0.1rc7</tt>
#<tt>$ sudo make install</tt>

If your environment does not allow git protocol, make install will fail because of fetching the submodules. This can be fixed by changing the submodule URLs:
#<tt>$ git config submodule.node_modules/abbrev.url https://github.com/isaacs/abbrev-js.git</tt>
#<tt>$ git config submodule.node_modules/nopt.url https://github.com/isaacs/nopt.git</tt>
#<tt>$ git config submodule.node_modules/semver.url https://github.com/isaacs/node-semver.git</tt>

==Install mongodb==
#<tt> $ sudo apt-get install mongodb</tt>

==Set up QA Dashboard==
Get the source and install dependencies
#<tt> $ git clone git://gitorious.org/meego-quality-assurance/qa-dashboard.git</tt>
#<tt> $ cd qa-dashboard</tt>
#<tt> $ npm install</tt>
QA Dashboard repository includes a default mongodb dump which can be used to populate the database.
#<tt> $ mongorestore</tt>

==Run the tests and start the server==
#Run unit tests:<tt> $ ./run-nodeunit.sh</tt>
#Start the server:<tt> $ ./run-server.sh</tt>
#Browse to http://localhost:3030

The server will start in development mode using node-supervisor, which watches for code changes and restarts the server accordingly.

Quality/QA-tools/QADashboard

2011-04-19T11:09:43Z

Tomilaine:

= QA Dashboard =

[http://qa-dashboard.leonidasoy.fi/ MeeGo QA Dashboard] is an application for viewing the quality at a glance. It uses various types of widgets to draw graphs and metrics to highlight interesting quality statistics. The service will be launched by the end of April.

== Environments ==
* [http://qa-dashboard.qa.leonidasoy.fi/ Staging environment - http://qa-dashboard.qa.leonidasoy.fi/]

== Source code ==
* [http://meego.gitorious.org/meego-quality-assurance/qa-dashboard Source code in Gitorious]

== Administration guide ==
* [[Quality/QA-tools/QADashboard/Setting_up_the_production_environment|Setting up the production environment]]

== Developer information ==
* [[Quality/QA-tools/QADashboard/Setting_up_the_development_environment|Setting up the development environment]]

== Contact information ==

QA Dashboard is developed by [[Quality/QA-tools | QA tools team]]. You can contact us via the following channels:
* [http://webchat.freenode.net/?channels=meego-qa #meego-qa IRC channel on irc.freenode.net]
* [http://bugs.meego.com/enter_bug.cgi?product=MeeGo%20Quality%20Assurance&component=qa-dashboard File new bugs or improvement ideas to Bugzilla]
* [http://bugs.meego.com/buglist.cgi?bug_status=NEW&bug_status=NEEDINFO&bug_status=INDEFINITION&bug_status=ASSIGNED&bug_status=ACCEPTED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=WAITING&bug_status=REOPENED&bug_status=RESOLVED&bug_status=RELEASED&bug_status=VERIFIED&component=qa-dashboard&query_format=advanced&order=priority%2Cbug_severity%2Cchangeddate%2Cbug_status%2Cassigned_to%2Cbug_id&query_based_on= Leave a comment or vote the items in our backlog]
* [http://lists.meego.com/listinfo/meego-qa meego-qa@lists.meego.com mailing list]

Quality/QA-tools/QADashboard

2011-04-14T14:55:59Z

Tomilaine:

= QA Dashboard =

[http://qa-dashboard.leonidasoy.fi/ MeeGo QA Dashboard] is an application for viewing the quality at a glance. It uses various types of widgets to draw graphs and metrics to highlight interesting quality statistics. The service will be launched by the end of April.

== Environments ==
* [http://qa-dashboard.qa.leonidasoy.fi/ Staging environment - http://qa-dashboard.qa.leonidasoy.fi/]

== Source code ==
* [http://meego.gitorious.org/meego-quality-assurance/qa-dashboard Source code in Gitorious]

== Developer information ==
* [[Quality/QA-tools/QADashboard/Setting_up_the_development_environment|Setting up the development environment]]

== Contact information ==

QA Dashboard is developed by [[Quality/QA-tools | QA tools team]]. You can contact us via the following channels:
* [http://webchat.freenode.net/?channels=meego-qa #meego-qa IRC channel on irc.freenode.net]
* [http://bugs.meego.com/enter_bug.cgi?product=MeeGo%20Quality%20Assurance&component=qa-dashboard File new bugs or improvement ideas to Bugzilla]
* [http://bugs.meego.com/buglist.cgi?bug_status=NEW&bug_status=NEEDINFO&bug_status=INDEFINITION&bug_status=ASSIGNED&bug_status=ACCEPTED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=WAITING&bug_status=REOPENED&bug_status=RESOLVED&bug_status=RELEASED&bug_status=VERIFIED&component=qa-dashboard&query_format=advanced&order=priority%2Cbug_severity%2Cchangeddate%2Cbug_status%2Cassigned_to%2Cbug_id&query_based_on= Leave a comment or vote the items in our backlog]
* [http://lists.meego.com/listinfo/meego-qa meego-qa@lists.meego.com mailing list]

Quality/QA-tools/QADashboard

2011-04-14T14:55:35Z

Tomilaine:

= QA Dashboard =

[http://qa-dashboard.leonidasoy.fi/ MeeGo QA Dashboard] is an application for viewing the quality at a glance. It uses various types of widgets to draw graphs and metrics to highlight interesting quality statistics. The service will be launched by the end of April.

== Environments ==
* [http://qa-reports.qa.leonidasoy.fi/ Staging environment - http://qa-dashboard.qa.leonidasoy.fi/]

== Source code ==
* [http://meego.gitorious.org/meego-quality-assurance/qa-dashboard Source code in Gitorious]

== Developer information ==
* [[Quality/QA-tools/QADashboard/Setting_up_the_development_environment|Setting up the development environment]]

== Contact information ==

QA Dashboard is developed by [[Quality/QA-tools | QA tools team]]. You can contact us via the following channels:
* [http://webchat.freenode.net/?channels=meego-qa #meego-qa IRC channel on irc.freenode.net]
* [http://bugs.meego.com/enter_bug.cgi?product=MeeGo%20Quality%20Assurance&component=qa-dashboard File new bugs or improvement ideas to Bugzilla]
* [http://bugs.meego.com/buglist.cgi?bug_status=NEW&bug_status=NEEDINFO&bug_status=INDEFINITION&bug_status=ASSIGNED&bug_status=ACCEPTED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=WAITING&bug_status=REOPENED&bug_status=RESOLVED&bug_status=RELEASED&bug_status=VERIFIED&component=qa-dashboard&query_format=advanced&order=priority%2Cbug_severity%2Cchangeddate%2Cbug_status%2Cassigned_to%2Cbug_id&query_based_on= Leave a comment or vote the items in our backlog]
* [http://lists.meego.com/listinfo/meego-qa meego-qa@lists.meego.com mailing list]

Quality/QA-tools

2011-04-14T14:49:59Z

Tomilaine:

= Quality assurance (QA) tools =

''' We moved our discussion to #meego-qa IRC channel as of March 24th 2011. Please join us there. '''

[[File:Tool_meegon.png|400px]]

Quality Assurance tools are developed to ensure MeeGo SW quality. QA tools team develops and maintains tools for quality assurance.

* "Open source tools – available for all, available for development and contributions. Make people accountable for quality."

'''Please note''' that developer-oriented content has been moved to [[Quality/QA tools development|QA tools development]] page. We apologize for any inconvenience. The target is to make this page clearer and more informative for the actual users of QA tools.

== Overview ==

QA tools support test planning, test execution and test reporting. The most important tool offering relating to this is illustrated in the figure below. In addition, there are also a couple of concept videos available at our [http://www.youtube.com/user/meegoqatools YouTube channel]:
* [http://www.youtube.com/watch?v=WdXBqGdLz8I Tool offering for manual testing]
* [http://youtu.be/Ry4MM-CX2b8 Test automation]

[[File:Meego-qa-tools.png|600px]]

== Tools, test suites and other utilities ==

If you want to contribute to the development of the following tools, test suites and utilities, please visit [[Quality/QA_tools_development|QA tools development page]].

'''Test tools'''

Each wiki page will contain more detailed description, installation instructions and tutorial on the basic usage. For now, please [[Quality/QA-tools#Collaboration spaces|contact us]] if you need help. Currently, you can install Testrunner, testrunner-lite, test-definition, Testplanner, OTS, Meego-ai, libcqpid, eat and MIN from Tools:Testing repository. The instructions for setting up the repositories can be found [[Quality/QA-tools/How_to_set_up_repositories|here]].

{| border="1" cellspacing="0"
|+
|'''Tool (link to wiki page)''' ||'''Short description'''
|-
| Crash Reporter || On-device tool for sending core dumps to core dump data base
|-
| [[Quality/QA-tools/MeeGo_Fast_Feedback_Testing|MeeGo Fast Feedback Testing (MeeGo-FFT)]] ||
|-
| [http://min.sf.net/ MIN Test Framework] || Advanced test framework
|-
| [[Quality/QA-tools/OTS|OTS - open testing system]] || Test automation system
|-
| [[Quality/QA-tools/Testplanner|Testplanner]] || Simple tool for creating and editing test plan files
|-
| [[Quality/QA-tools/Testrunner-lite|testrunner-lite]] ||Command line tool for test execution
|-
| [[Quality/QA-tools/Testrunner|Testrunner]] || Test execution tool with graphical UI
|-
| [[Quality/QA-tools/TDriver|Testability Driver]] || Comprehensive tool for UI testing
|-
| [[Quality/QA-tools/QAReports|QA Reports]] || Reporting tool for publishing test reports
|-
| [[Quality/QA-tools/QADashboard|QA Dashboard]] || Quality at a glance
|}

'''Test suites'''

{| border="1" cellspacing="0"
|+
|'''Test suite (link to wiki page)''' ||| '''Test plans'''
|-
| [[Quality/TestSuite/MCTS|MeeGo Core Test Suite]] ||[http://testplans.meego.com/mcts/ Link]
|-
| [[Quality/TestSuite/handset-test-suite/handset-ux-test_Releases |MeeGo Handset UX Test Suite]] ||[http://testplans.meego.com/handset-ux-tests/ Link]
|-
| [[Quality/Netbook Test Suite and Utilities|MeeGo Netbook Test Suite]] ||[http://testplans.meego.com/mnts/ Link]
|-
| MeeGo SDK Test Suite ||[http://testplans.meego.com/meego-sdk-tests/ Link]
|}

'''Other utilities'''

{| border="1" cellspacing="0"
|+
|'''Name (link to wiki page)''' ||'''Short description'''
|-
|[[Quality/QA-tools/Test-definition|test-definition]]|| XML schema for test plan and result files
|-
| [[Quality/QA-tools/Eat|eat - enables automated testing]] || Test automation configuration packages
|-
| [[Quality/QA-tools/Autotest-guide#Automatic_image_installations|MeeGo Automated installer]] ||
|-
| [[Quality/QA-tools/qtuitest-mbt-adapter|Model-Based Testing adapter for qtuitest]] ||
|-
| Rich Core dumper ||
|-
| Crash Reporter settings || Settings package for Crash Reporter
|-
| [[Quality/QA-tools/hat-control|Hardware Accessory for Testing (HAT)]] ||
|-
| [[Quality/QA-tools/Scripts_and_utils|Scripts and utils]] ||
|-
| Service OS based Flasher ||
|-
| [[Quality/QA-tools/Qpid C wrapper|Qpid C wrapper library - libcqpid]] ||
|}

== Feature requests and bugs ==

Want to report an feature idea or bug to us? - [http://bugs.meego.com/enter_bug.cgi?product=MeeGo%20Quality%20Assurance Please do it here]

* [http://bugs.meego.com/buglist.cgi?query_format=advanced&order=Importance&bug_status=ASSIGNED&component=eat&component=Fast%20Feedback%20Testing&component=hat&component=libcqpid&component=meego-qa-reports&component=min&component=ots&component=TDriver&component=testdefinition&component=Testplanner&component=Testrunner&component=testrunner-lite&component=Others&classification=MeeGo%20Projects&product=MeeGo%20Quality%20Assurance Assigned bugs and features - Working on it]
* [http://bugs.meego.com/buglist.cgi?query_format=advanced&order=Importance&bug_status=NEW&bug_status=NEEDINFO&bug_status=ASSIGNED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=REOPENED&bug_status=RESOLVED&component=eat&component=Fast%20Feedback%20Testing&component=hat&component=libcqpid&component=meego-qa-reports&component=min&component=ots&component=TDriver&component=testdefinition&component=Testplanner&component=Testrunner&component=testrunner-lite&component=Others&classification=MeeGo%20Projects&product=MeeGo%20Quality%20Assurance All open features and bugs in priority order]

Bugzilla instructions:
* [[Quality/How To Report Bugs|How to report bugs]]
* [[Quality/Bug Life Cycle and Handling|Bugzilla workflow]]

== Collaboration spaces ==

Team communication is in English. Our collaboration spaces are:
* [http://lists.meego.com/listinfo/meego-qa meego-qa@lists.meego.com mailing list]
* [http://webchat.freenode.net/?channels=meego-qa #meego-qa IRC channel on irc.freenode.net]
* [http://www.youtube.com/user/meegoqatools YouTube channel for demo videos]
* [http://meegoqatools.wordpress.com/ QA-tools team blog]

[[Category:QA]]

Quality/QA-tools/QADashboard/Setting up the development environment

2011-04-14T14:48:55Z

Tomilaine:

Quality/QA-tools/QADashboard/Setting up the development environment

2011-04-14T13:23:39Z

Tomilaine: Created page with "==Introduction== QA Dashboard is a [http://nodejs.org/ Node.js] application. It is written in [http://jashkenas.github.com/coffee-script/ coffee-script] and uses [http://www.mon..."

Quality/QA-tools/QADashboard

2011-04-14T12:21:26Z

Tomilaine: Created page with "= QA Dashboard = [http://qa-dashboard.leonidasoy.fi/ MeeGo QA Dashboard] is an application for viewing the quality at a glance. It uses various types of widgets to draw graphs a..."

= QA Dashboard =

[http://qa-dashboard.leonidasoy.fi/ MeeGo QA Dashboard] is an application for viewing the quality at a glance. It uses various types of widgets to draw graphs and metrics to highlight interesting quality statistics. The service will be launched by the end of April.

== Environments ==
* [http://qa-reports.qa.leonidasoy.fi/ Staging environment - http://qa-reports.qa.leonidasoy.fi/]

== Source code ==
* [http://meego.gitorious.org/meego-quality-assurance/qa-dashboard Source code in Gitorious]

== Developer information ==
* [[Quality/QA-tools/QADashboard/Setting_up_the_development_environment|Setting up the development environment]]

== Contact information ==

QA Dashboard is developed by [[Quality/QA-tools | QA tools team]]. You can contact us via the following channels:
* [http://webchat.freenode.net/?channels=meego-qa #meego-qa IRC channel on irc.freenode.net]
* [http://bugs.meego.com/enter_bug.cgi?product=MeeGo%20Quality%20Assurance&component=qa-dashboard File new bugs or improvement ideas to Bugzilla]
* [http://bugs.meego.com/buglist.cgi?bug_status=NEW&bug_status=NEEDINFO&bug_status=INDEFINITION&bug_status=ASSIGNED&bug_status=ACCEPTED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=WAITING&bug_status=REOPENED&bug_status=RESOLVED&bug_status=RELEASED&bug_status=VERIFIED&component=qa-dashboard&query_format=advanced&order=priority%2Cbug_severity%2Cchangeddate%2Cbug_status%2Cassigned_to%2Cbug_id&query_based_on= Leave a comment or vote the items in our backlog]
* [http://lists.meego.com/listinfo/meego-qa meego-qa@lists.meego.com mailing list]

Quality/QA-tools

2011-04-14T11:25:28Z

Tomilaine:

= Quality assurance (QA) tools =

''' We moved our discussion to #meego-qa IRC channel as of March 24th 2011. Please join us there. '''

[[File:Tool_meegon.png|400px]]

Quality Assurance tools are developed to ensure MeeGo SW quality. QA tools team develops and maintains tools for quality assurance.

* "Open source tools – available for all, available for development and contributions. Make people accountable for quality."

'''Please note''' that developer-oriented content has been moved to [[Quality/QA tools development|QA tools development]] page. We apologize for any inconvenience. The target is to make this page clearer and more informative for the actual users of QA tools.

== Overview ==

QA tools support test planning, test execution and test reporting. The most important tool offering relating to this is illustrated in the figure below. In addition, there are also a couple of concept videos available at our [http://www.youtube.com/user/meegoqatools YouTube channel]:
* [http://www.youtube.com/watch?v=WdXBqGdLz8I Tool offering for manual testing]
* [http://youtu.be/Ry4MM-CX2b8 Test automation]

[[File:Meego-qa-tools.png|600px]]

== Tools, test suites and other utilities ==

If you want to contribute to the development of the following tools, test suites and utilities, please visit [[Quality/QA_tools_development|QA tools development page]].

'''Test tools'''

Each wiki page will contain more detailed description, installation instructions and tutorial on the basic usage. For now, please [[Quality/QA-tools#Collaboration spaces|contact us]] if you need help. Currently, you can install Testrunner, testrunner-lite, test-definition, Testplanner, OTS, Meego-ai, libcqpid, eat and MIN from Tools:Testing repository. The instructions for setting up the repositories can be found [[Quality/QA-tools/How_to_set_up_repositories|here]].

{| border="1" cellspacing="0"
|+
|'''Tool (link to wiki page)''' ||'''Short description'''
|-
| Crash Reporter || On-device tool for sending core dumps to core dump data base
|-
| [[Quality/QA-tools/MeeGo_Fast_Feedback_Testing|MeeGo Fast Feedback Testing (MeeGo-FFT)]] ||
|-
| [http://min.sf.net/ MIN Test Framework] || Advanced test framework
|-
| [[Quality/QA-tools/OTS|OTS - open testing system]] || Test automation system
|-
| [[Quality/QA-tools/Testplanner|Testplanner]] || Simple tool for creating and editing test plan files
|-
| [[Quality/QA-tools/Testrunner-lite|testrunner-lite]] ||Command line tool for test execution
|-
| [[Quality/QA-tools/Testrunner|Testrunner]] || Test execution tool with graphical UI
|-
| [[Quality/QA-tools/TDriver|Testability Driver]] || Comprehensive tool for UI testing
|-
| [[Quality/QA-tools/QAReports|QA Reports]] || Reporting tool for publishing test reports
|-
| [[Quality/QA-tools/QADashboard|QA Dashboard]] || Quality at glance
|}

'''Test suites'''

{| border="1" cellspacing="0"
|+
|'''Test suite (link to wiki page)''' ||| '''Test plans'''
|-
| [[Quality/TestSuite/MCTS|MeeGo Core Test Suite]] ||[http://testplans.meego.com/mcts/ Link]
|-
| [[Quality/TestSuite/handset-test-suite/handset-ux-test_Releases |MeeGo Handset UX Test Suite]] ||[http://testplans.meego.com/handset-ux-tests/ Link]
|-
| [[Quality/Netbook Test Suite and Utilities|MeeGo Netbook Test Suite]] ||[http://testplans.meego.com/mnts/ Link]
|-
| MeeGo SDK Test Suite ||[http://testplans.meego.com/meego-sdk-tests/ Link]
|}

'''Other utilities'''

{| border="1" cellspacing="0"
|+
|'''Name (link to wiki page)''' ||'''Short description'''
|-
|[[Quality/QA-tools/Test-definition|test-definition]]|| XML schema for test plan and result files
|-
| [[Quality/QA-tools/Eat|eat - enables automated testing]] || Test automation configuration packages
|-
| [[Quality/QA-tools/Autotest-guide#Automatic_image_installations|MeeGo Automated installer]] ||
|-
| [[Quality/QA-tools/qtuitest-mbt-adapter|Model-Based Testing adapter for qtuitest]] ||
|-
| Rich Core dumper ||
|-
| Crash Reporter settings || Settings package for Crash Reporter
|-
| [[Quality/QA-tools/hat-control|Hardware Accessory for Testing (HAT)]] ||
|-
| [[Quality/QA-tools/Scripts_and_utils|Scripts and utils]] ||
|-
| Service OS based Flasher ||
|-
| [[Quality/QA-tools/Qpid C wrapper|Qpid C wrapper library - libcqpid]] ||
|}

== Feature requests and bugs ==

Want to report an feature idea or bug to us? - [http://bugs.meego.com/enter_bug.cgi?product=MeeGo%20Quality%20Assurance Please do it here]

* [http://bugs.meego.com/buglist.cgi?query_format=advanced&order=Importance&bug_status=ASSIGNED&component=eat&component=Fast%20Feedback%20Testing&component=hat&component=libcqpid&component=meego-qa-reports&component=min&component=ots&component=TDriver&component=testdefinition&component=Testplanner&component=Testrunner&component=testrunner-lite&component=Others&classification=MeeGo%20Projects&product=MeeGo%20Quality%20Assurance Assigned bugs and features - Working on it]
* [http://bugs.meego.com/buglist.cgi?query_format=advanced&order=Importance&bug_status=NEW&bug_status=NEEDINFO&bug_status=ASSIGNED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=REOPENED&bug_status=RESOLVED&component=eat&component=Fast%20Feedback%20Testing&component=hat&component=libcqpid&component=meego-qa-reports&component=min&component=ots&component=TDriver&component=testdefinition&component=Testplanner&component=Testrunner&component=testrunner-lite&component=Others&classification=MeeGo%20Projects&product=MeeGo%20Quality%20Assurance All open features and bugs in priority order]

Bugzilla instructions:
* [[Quality/How To Report Bugs|How to report bugs]]
* [[Quality/Bug Life Cycle and Handling|Bugzilla workflow]]

== Collaboration spaces ==

Team communication is in English. Our collaboration spaces are:
* [http://lists.meego.com/listinfo/meego-qa meego-qa@lists.meego.com mailing list]
* [http://webchat.freenode.net/?channels=meego-qa #meego-qa IRC channel on irc.freenode.net]
* [http://www.youtube.com/user/meegoqatools YouTube channel for demo videos]
* [http://meegoqatools.wordpress.com/ QA-tools team blog]

[[Category:QA]]

Quality/QA-tools/QAReports

2011-04-14T11:19:14Z

Tomilaine:

= QA Reports =

[[File:MeeGoQAReports.png|right|415px]]

[http://qa-reports.meego.com/ MeeGo QA reports] is test reporting application for anyone testing MeeGo. Introductory screencast is available at [http://www.youtube.com/watch?v=yr_IdmqGniE YouTube]. You can also [http://dl.dropbox.com/u/10001820/QA%20Reports%20tutorial%20part%201.mp4 download the video].

== Access to MeeGo QA reports ==

Access to '''publish''' MeeGo QA reports is provided on need and request basis. If you need access please file a request at [http://bugs.meego.com/enter_bug.cgi?product=MeeGo%20Quality%20Assurance MeeGo Quality Assurance > Others]

You can also create yourself a test account at [http://qa-reports.qa.leonidasoy.fi/users/register staging environment] and play around with the system.

== User Documentation ==

* [[Quality/QA-tools/QAReports/Basic_Workflow|User guide]]
* [[Quality/QA-tools/QAReports/API|API Documentation]]
* [[Quality/QA-tools/QAReports/User_FAQ|F.A.Q]]

== Administration Guide ==

* [[Quality/QA-tools/QAReports/Setting_up_the_production_environment|Setting up the production environment]]
* [[Quality/QA-tools/QAReports/Admin_FAQ|F.A.Q]]

== Environments ==

* [http://qa-reports.meego.com/ Production environment - http://qa-reports.meego.com]
* [http://qa-reports.qa.leonidasoy.fi/ Staging environment - http://qa-reports.qa.leonidasoy.fi/]

== Source code ==

* [http://meego.gitorious.org/meego-quality-assurance/qa-reports Source code in Gitorious]

== Developer information ==

* [[Quality/QA-tools/QAReports/Setting_up_the_development_environment|Setting up the development environment]]
* [[Quality/QA-tools/QAReports/Contributing_to_qa-reports|Contributing to MeeGo QA Reports]]

== Contact information ==

QA Reports is developed by [[Quality/QA-tools | QA tools team]]. You can contact us via the following channels:
* [http://webchat.freenode.net/?channels=meego-qa #meego-qa IRC channel on irc.freenode.net]
* [http://bugs.meego.com/enter_bug.cgi?product=MeeGo%20Quality%20Assurance&component=meego-qa-reports File new bugs or improvement ideas to Bugzilla]
* [http://bugs.meego.com/buglist.cgi?bug_status=NEW&bug_status=NEEDINFO&bug_status=INDEFINITION&bug_status=ASSIGNED&bug_status=ACCEPTED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=WAITING&bug_status=REOPENED&bug_status=RESOLVED&bug_status=RELEASED&bug_status=VERIFIED&component=meego-qa-reports&query_format=advanced&order=priority%2Cbug_severity%2Cchangeddate%2Cbug_status%2Cassigned_to%2Cbug_id&query_based_on= Leave a comment or vote the items in our backlog]
* [http://lists.meego.com/listinfo/meego-qa meego-qa@lists.meego.com mailing list]