- Administrator privileges
- JDBC Oracle driver
- Java 8 SDK
- JRuby 126.96.36.199
- Node.js >=8.9.4
- Rubygems 2.5.1
- RVM - Ruby version managers
- xvfb - xvfb headless browser, included for Macs with XQuartz
Install Java 8 JDK (8u172): http://www.oracle.com/technetwork/java/javase/downloads/index.html
Note: To install Postgres, you must first install Homebrew.
Install Homebrew with the following command:
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
Run the following command in Terminal after installation:
Then run the following:
brew update brew install postgresql
For Mountain Lion & Mavericks users ONLY: Fix Postgres paths.
For Mountain Lion & Mavericks users ONLY: If you can connect to Postgres via psql, but not via JDBC (you see "Connection refused" errors in the CalCentral app log), then edit
/usr/local/var/postgres/pg_hba.confand make sure you have these lines:
host all all 127.0.0.1/32 md5 host all all samehost md5
For Mountain Lion & Mavericks users ONLY: Install XQuartz and make sure that /opt/X11/bin is on your
Start Postgres, add users and create the necessary databases. (If your PostgreSQL server is managed externally, you'll probably need to create a schema that matches the database username. See CLC-893 for details.):
pg_ctl -D /usr/local/var/postgres -l /usr/local/var/postgres/server.log start psql postgres create database calcentral_development; create user calcentral_development with password 'secret' createdb; grant all privileges on database calcentral_development to calcentral_development; alter database calcentral_development owner to calcentral_development; create database calcentral; create user calcentral with password 'secret' createdb; grant all privileges on database calcentral to calcentral; alter database calcentral owner to calcentral; create database calcentral_test; create user calcentral_test with password 'secret' createdb; grant all privileges on database calcentral_test to calcentral_test; alter database calcentral_test owner to calcentral_test; \q
Note: At this point, exit out of Postgres. To do this, type "\q" and then press ENTER.
Fork this repository, then:
with ssh (note)
git clone firstname.lastname@example.org:[your GitHub Account]/calcentral.git # e.g. git clone email@example.com:christianv/calcentral.git
or via https - (note)
git clone https://github.com/[your Github Account]/calcentral.git # e.g. git clone https://github.com/christianv/calcentral.git
Go inside the
cd calcentral # Answer "yes" if it asks you to trust a new .rvmrc file.
Install JRuby (requires ):
Note: To install JRuby, you must first install rvm.
rvm get head rvm install jruby-188.8.131.52 cd .. cd calcentral # Answer "yes" again if it asks you to trust a new .rvmrc file. rvm list # Make sure that everything looks fine # If it mentions "broken", you'll need to reinstall
Make JRuby faster for local development by running this or put in your .bashrc:
Configure Default JRuby and Gemset
cd ~ rvm use jruby-184.108.40.206 --default # This may output 'Unknown ruby string (do not know how to handle): jruby-220.127.116.11.', which can be ignored. rvm gemset use global
Download and install xvfb. On a Mac, you get xvfb by installing XQuartz.
Download the appropriate gems with Bundler:
Important: Make sure you have the JRuby-upgraded CalCentral codebase in your calcentral directory before running
rvm rubygems 2.5.1 --force gem --version # Should output '2.5.1' gem uninstall bundler --force -x gem install bundler --version="1.15.4" bundle install
Set up a local settings directory:
Default settings are loaded from your source code in
config/settings/ENVIRONMENT_NAME.yml. For example, the configuration used when running tests with
RAILS_ENV=testis determined by the combination of
config/settings.yml. Because we don't store passwords and other sensitive data in source code, any RAILS_ENV other than
testrequires overriding some default settings. Do this by creating
ENVIRONMENT.local.ymlfiles in your
~/.calcentral_configdirectory. For example, your
~/.calcentral_config/development.local.ymlfile may include access tokens and URLs for a locally running Canvas server. You can also create Ruby configuration files like "settings.local.rb" and "development.local.rb" to amend the standard
Install JDBC driver (for Oracle connection)
- Download ojdbc7_g.jar
- Note: You do not have to open the file.
- Rename the file to
Initialize PostgreSQL database tables:
bundle exec rake environment db:schema:load db:seed
Make yourself powerful:
bundle exec rake superuser:create UID=[your numeric CalNet UID] # e.g. rake superuser:create UID=61889
Install the front-end tools:
brew install node npm install npm install -g gulp
Start the front-end development server, or kick off a Webpack build:
# starts development server npm run dev # starts build process npm run build
Start the server:
Note: Usually you won't have to do any of the following steps when you're developing on CalCentral.
Back-end (rspec) tests live in
To run the tests from the command line:
To run the tests faster, use spork, which is a little server that keeps the Rails app initialized while you change code and run multiple tests against it. Command line:
spork # (...wait a minute for startup...) rspec --drb spec/lib/my_spec.rb
You can even run Spork right inside IntelliJ RubyMine or IDEA.
Front-end linting can be done by running the following commands:
npm run lint
Some features of CalCentral are only accessible to users with particular roles, such as
These features may be invisible when logged in as yourself. In particular:
- My Academics will only appear in the navigation if logged in as a student. However, the "Oski Bear" test student does not fake data loaded on dev and QA. To test My Academics, log in as user
test-212381(ask a developer for the passwords to these if you need them). Once logged in as a test student, append
/academicsto the URL to access My Academics.
Emulating production mode locally
Make sure you have a separate production database:
psql postgres create database calcentral_production; grant all privileges on database calcentral_production to calcentral_development;
In calcentral_config/production.local.yml, you'll need the following entries:
secret_token: "Some random 30-char string" postgres: [credentials for your separate production db (copy/modify from development.local.yml)] google_proxy: and canvas_proxy: [copy from development.local.yml] application: serve_static_assets: true
Populate the production db by invoking your production settings:
RAILS_ENV="production" rake db:schema:load db:seed
Precompile the front-end assets
npm run build
Start the server in production mode:
rails s -e production
If you're not able to connect to Google or Canvas, export the data in the oauth2 from your development db and import them into the same table in your production db.
After testing, remember to remove the static assets, or run another build before the next task.
Start the server with TorqueBox
In production we use TorqueBox as this provides us with messaging, scheduling, caching, and daemons.
Deploy into TorqueBox (only needs to happen once in a while):
bundle exec torquebox deploy .
Start the server:
bundle exec torquebox run -p=3000
Make sure you are on the Berkeley network or connected through preconfigured VPN for the Oracle connection.
If you use a VPN, use group
Enable basic authentication
Basic authentication will enable you to log in without using CAS. This is necessary when your application can't be CAS authenticated or when you're testing mobile browsers. Note: only enable this in fake mode or in development.
Add the following setting to your
developer_auth: enabled: true password: topsecret!
(Re)start the server for the changes to take effect.
Click on the footer (Berkeley logo) when you load the page.
You should be seeing the Basic Auth screen. As the login you should use a UID (e.g.
61889for oski) and then the password from the settings file.
"Act As" another user
To help another user debug an issue, you can "become" them on CalCentral. To assume the identity of another user, you must:
- Currently be logged in as a designated superuser
- Be accessing a machine/server which the other user has previously logged into (e.g. from localhost, you can't act as a random student, since that student has probably never logged in at your terminal)
Access the URL:
where 123456 is the UID of the user to emulate.
Note: The Act As feature will only reveal data from data sources we control, e.g. Canvas. Google data will be completely suppressed, EXCEPT for test users. The following user uids have been configured as test users.
- 11002820 - "Tammi Chang"
- 61889 - "Oski Bear"
- All IDs listed on the Universal Calnet Test IDs page
To become yourself again, access:
Logging behavior and destination can be controlled from the command line or shell scripts via env variables:
LOGGER_STDOUT=false- Only log to the default files
LOGGER_STDOUT=true- Log to standard output as well as the default files
LOGGER_STDOUT=only- Only log to standard output
LOGGER_LEVEL=DEBUG- Set logging level; acceptable values are 'FATAL', 'ERROR', 'WARN', 'INFO', and 'DEBUG'
On Mac OS X, to get RubyMine to pick up the necessary environment variables, open a new shell, set the environment variables, and:
If you want to explore the Oracle database on Mac OS X, use SQL Developer.
Creating timeshifted fake data feeds
Proxies running in fake mode use WebMock to substitute fixture data for connections to external services (Canvas, Google, etc). This fake data lives in
Fixture files can represent time information by tokens that are substituted with appropriately shifted values when fixture data is loaded. See
config/initializers/timeshift.rb for the dictionary of substitutions.
To view other rake task for the project:
rake spec:xml- Runs rake spec, but pipes the output to xml using the
rspec_junit_formattergem, for JUnit compatible test result reports
Dev, QA, and Production CalCentral environments use memcached as a cache store in place of the default ActiveSupport cache store.
To set this up locally, perform the following steps:
Install and run memcached.
Add the following lines to development.local.yml:
cache: store: "memcached"
A few rake tasks to help monitor statistics and more:
rake memcached:clear- Invalidate all memcached keys and reset memcached stats from all cluster nodes.
rake memcached:get_stats- Fetch memcached stats from all cluster nodes. Per-slab stats may point out specific types of data which are being overcached or undercached, or indicate a need to reconfigure memcached.
rake memcached:dump_slab slab=NUMBER- Shows which cached items are currently stored in the "slab" with the given ID. The list won't include the keys of expired or evicted items.
WARNING: do not run
rake memcached:clearon the production cluster unless you know what you're doing!
memcachedtasks take the optional param of
hosts. So, if say you weren't running these tasks on the cluster layers themselves, or only wanted to tinker with a certain subset of clusters:
rake memcached:get_stats hosts="localhost:11212,localhost:11213,localhost:11214"
Using the feature toggle:
To selectively enable/disable a feature, add a property to the
features section of settings.yml, e.g.:
features: wizbang: false neato: true
After server restart, these properties will appear in each users' status feed. You can now use
data-ng-if in Angular to wrap the feature:
<div data-ng-if="user.profile.features.neato"> Some neato feature... </div>
Keeping developer seed data updated
seeds.rb is intended for use only on developer machines, so they have a semi-realistic copy of production lists of
superusers, links, etc.
./db/developer-seed-data.sql has the data used by
rake db:seed. Occasionally we'll want to
update it from production. To do that, log into a prod node and do:
pg_dump calcentral -O -x --inserts --clean -f developer-seed-data.sql -t link_categories \ -t link_categories_link_sections -t link_sections -t link_sections_links -t links \ -t links_user_roles -t user_auths -t user_roles -t fin_aid_years \ -h postgres-hostname -p postgres-port-number -U calcentral
Copy the file into your source tree and get it merged into master.
To generate this styleguide run:
This will generate the styleguide in public/styleguide, which will open automatically in your browser at http://localhost:3006/. Modifications to SCSS files under /src/assets/stylesheets are watched and reloaded into the guide on-the-fly.