tree: f1c82fea267d24408db5f157f5b0b5bbde3ba0f8 [path history] [tgz]
  1. .coveragerc
  2. .expect_tests.cfg
  3. .expect_tests_pretest.py
  4. .gitignore
  5. Makefile
  6. OWNERS
  7. README.md
  8. api/
  9. app.yaml
  10. appengine_config.py
  11. benchmark/
  12. bower.json
  13. businesslogic/
  14. codereview.settings
  15. cron.yaml
  16. doc/
  17. dos.yaml
  18. elements/
  19. features/
  20. framework/
  21. module-besearch.yaml
  22. monorailapp.py
  23. package-lock.json
  24. package.json
  25. polymer-test/
  26. project/
  27. proto/
  28. queue.yaml
  29. registerpages.py
  30. schema/
  31. search/
  32. services/
  33. settings.py
  34. sitewide/
  35. static/
  36. templates/
  37. testing/
  38. third_party/
  39. tools/
  40. tracker/
appengine/monorail/README.md

Monorail Issue Tracker

Monorail is the Issue Tracker used by the Chromium project and other related projects. It is hosted at bugs.chromium.org.

If you wish to file a bug against Monorail itself, please do so in our self-hosting tracker. We also discuss development of Monorail at infra-dev@chromium.org.

Getting started with Monorail development

Here's how to run Monorail locally for development on any unix system (not under google3):

  1. You need to get the Chrome Infra depot_tools commands to check out the source code and all its related dependencies and to be able to send changes for review.
  2. Check out the Monorail source code
    1. cd /path/to/empty/workdir
    2. fetch infra
    3. cd infra/appengine/monorail
  3. Make sure you have the AppEngine SDK:
    1. It should be fetched for you by step 1 above (during runhooks)
    2. Otherwise, you can download it from https://developers.google.com/appengine/downloads#Google_App_Engine_SDK_for_Python
  4. Install MySQL v5.6. Either download directly, or if you're on an Ubuntu derivative:
    1. Do not download v5.7 (as of April 2016)
    2. sudo apt-get install mysql-server mysql-client
  5. Get the database backend running and use the command-line to create a database named “monorail”:
    1. sudo /usr/local/mysql/bin/mysqld_safe
    2. mysql --user=root --password=<pw>
    3. CREATE DATABASE monorail;
  6. Install Python MySQLdb. Either:
    1. sudo apt-get install python-mysqldb
    2. Or, download from http://sourceforge.net/projects/mysql-python/
      1. Follow instructions to install.
      2. If needed, add these lines to your ~/.profile file and restart on MacOS 10.8:
        1. setenv DYLD_LIBRARY_PATH /usr/local/mysql/lib/
        2. setenv VERSIONER_PYTHON_PREFER_64_BIT no
        3. setenv VERSIONER_PYTHON_PREFER_32_BIT yes
      3. In Mac OSX 10.11.1, if you see errors about failing to import MySQLdb or that _mysql.so references an untrusted relative path, then run: sudo install_name_tool -change libmysqlclient.18.dylib
        /usr/local/mysql/lib/libmysqlclient.18.dylib
        /Library/Python/2.7/site-packages/_mysql.so
  7. Set up one master SQL database. (You can keep the same sharding options in settings.py that you have configured for production.).
    1. mysql --user=root monorail < schema/framework.sql
    2. mysql --user=root monorail < schema/project.sql
    3. mysql --user=root monorail < schema/tracker.sql
  8. Configure the site defaults in settings.py. You can leave it as-is for now.
  9. Set up the front-end development environment:
    1. Make sure you've run gclient runhooks, which will install the correct versions of node and npm.
    2. Run npm install -g bower to install Bower.
  10. Run the app:
    1. You can use ‘make serve’, or
    2. Run the app with AppEngine dev_appserver.py with the command: ../../../google_appengine/dev_appserver.py --mysql_user=root app.yaml module-besearch.yaml
  11. Browse the app at localhost:8080 your browser.
  12. Optional: Create/modify your Monorail User row in the database and make that user a site admin.
    1. UPDATE User SET is_site_admin = TRUE WHERE email = 'YOUR@EMAIL';
    2. Restart your local dev appserver.

Instructions for deploying Monorail to an existing instance or setting up a new instance are here.

Here's how to run unit tests from the command-line:

Testing

To run all Python unit tests, in the appengine/monorail directory run:

make test

For quick debugging, if you need to run just one test you can do the following. For instance for the test IssueServiceTest.testUpdateIssues_Normal in services/test/issue_svc_test.py:

../../test.py test appengine/monorail:services.test.issue_svc_test.IssueServiceTest.testUpdateIssues_Normal --no-coverage

Troubleshooting

  • **TypeError: connect() got an unexpected keyword argument ‘charset’ This error occurs when dev_appserver cannot find the MySQLdb library. Try installing it via sudo apt-get install python-mysqldb.
  • TypeError: connect() argument 6 must be string, not None This occurs when your mysql server is not running. Check if it is running with ps aux | grep mysqld. Start it up with /etc/init.d/mysqld start on linux, or just mysqld.
  • dev_appserver says OSError: [Errno 24] Too many open files and then lists out all source files dev_appserver wants to reload source files that you have changed in the editor, however that feature does not seem to work well with multiple GAE modules and instances running in different processes. The workaround is to control-C or kill the dev_appserver processes and restart them.

Supported browsers

Monorail supports all browsers defined in the Chrome Ops guidelines.

File a browser compatability bug here.