/release_dash

Dashboard for tracking Release Statuses of Mozillian Awesomeness.

Primary LanguagePHPMozilla Public License 2.0MPL-2.0

Release Readiness Dashboard

Dashboards for tracking Release Statuses of Mozillian Awesomeness.
Change logs, progress updates and latest developments on this spreadsheet

Deployment

Configuring the Database credentials

  • Environment development stored in /application/config/database.php
  • Environment production stored in /application/config/production/database.php
    • Actual file is gitignored to protect your private credentials
    • Template is saved as /application/config/production/database_template.php
    • Use inline variables when deployed as Stackato application with a binded MySQL service

Instructions for deployment on Stackato

  1. Clone the repository onto your local machine
  2. Setup production database credentials as specified above
  3. Open /stackato.yml and modify the following:
    • name Sub-domain where the dashboard will be accessed
    • The rest of the configs have already been setup for you
  4. $ cd into the root directory of the cloned repository using Terminal
  5. Assuming that stackato is already installed, execute $ stackato push
  6. The web application is now live on the internet
    • Application's database (MySQL service) is set up but still empty
    • Populate the database with data in /assets/sql/dataset.sql by:
      • Tunnel into the MySQL service via Stackato
      • OR Deploy phpMyAdmin for Stackato (recommended)
  7. In future, update the code base by using Terminal:
    • $ cd into the dashboard's repository on your local machine
    • Run the command for $ stackato update [dashboard's appname]

Instructions for deploying phpMyAdmin on Stackato

  1. Clone this repository onto your local machine
  2. Open /stackato.yml and modify the following:
    • name Sub-domain where phpMyAdmin will be accessed
    • services Remove MySQL from being created (not needed)
    • PMA_USERNAME Login credentials for accessing phpMyAdmin
    • PMA_PASSWORD Login credentials for accessing phpMyAdmin
  3. $ cd into the root directory of the cloned repository using Terminal
  4. Assuming that stackato is already installed, execute $ stackato push
  5. phpMyAdmin is now live on the internet
    • However, it is still not binded to the application's database. To do this:
      • Identify the MySQL service that was created with the dashboard application
      • Run the command for $ stackato bind-service <servicename> [phpMyAdmin's appname]
      • Logging into phpMyAdmin should now display all the schema and data used by the dashboard

Instructions for deployment on other hosting services

  • Standard Web Stack: Apache, MySQL, PHP 5.3 and above
  • For deployment on local machine, try LAMP, MAMP or WAMP

URL Walkthrough

Landing page

  • Accessed through "/" or "/overview"
  • Provides an overview of all active versions
  • Executes from: /application/controllers/overview.php/index
  • More details...

Version page

Administrator login page

  • Accessed through "/admin"
  • Allows a whitelisted user to sign in using Persona
  • Executes from: /application/controllers/admin.php/index

Qb query builder page

  • Accessed through "/admin/easy_qb"
  • Translates Bugzilla URLs into Qb queries
  • Executes from: /application/controllers/admin.php/easy_qb
  • More details...

User guide page

  • Accessed through "/admin/help" or "/help"
  • Read-able manual to help with getting started
  • Executes from: /application/controllers/admin.php/help

Update components

  • Accessed through "/admin/update_components"
  • Grabs product components from Bugzilla and updates database
  • Executes from: /application/controllers/admin.php/update_components

Update cycle

  • Accessed through "/admin/update_cycle"
  • Checks for new cycle and updates accordingly
  • Automatically called when a current cycle is not found
  • Executes from: /application/controllers/admin.php/update_cycle
  • More details...

Testing

Unit tests

  • Accessed and run through "/test"
  • Currently testing CRUD for version model and helper functions
  • Needs unit tests for other models as well as functions derived from base CRUD
  • Creates a test version on each run, uses it then deletes it immediately at the end

Troubleshoot

Reach out to Willie Cheong for undocumented problems.

References

License

Mozilla Public Liscense v2.0