- Administrator privileges
- Bundler
- Git
- JDBC Oracle driver
- Java 8 SDK
- JRuby 9.1.14.0
- Node.js >=8.9.4
- PostgreSQL
- 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
-
Install Postgres:
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:
brew --version
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.conf
and 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
PATH
.
-
-
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 [email protected]:[your GitHub Account]/calcentral.git # e.g. git clone [email protected]: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
calcentral
repository: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-9.1.14.0 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:
export JRUBY_OPTS="--dev"
-
Configure Default JRuby and Gemset
cd ~ rvm use jruby-9.1.14.0 --default # This may output 'Unknown ruby string (do not know how to handle): jruby-9.1.14.0.', 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
bundle install
.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:
mkdir ~/.calcentral_config
Default settings are loaded from your source code in
config/settings.yml
andconfig/settings/ENVIRONMENT_NAME.yml
. For example, the configuration used when running tests withRAILS_ENV=test
is determined by the combination ofconfig/settings/test.yml
andconfig/settings.yml
. Because we don't store passwords and other sensitive data in source code, any RAILS_ENV other thantest
requires overriding some default settings. Do this by creatingENVIRONMENT.local.yml
files in your~/.calcentral_config
directory. For example, your~/.calcentral_config/development.local.yml
file 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 standardconfig/environments/*.rb
files. -
Install JDBC driver (for Oracle connection)
- Download ojdbc7_g.jar
- Note: You do not have to open the file.
- Rename the file to
ojdbc7.jar
- Copy
ojdbc7.jar
to~/.rvm/rubies/jruby-9.1.14.0/lib/
-
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:
rails s
-
Access your rails server at localhost:3000, or the Webpack development server at localhost:3001. Do not use 127.0.0.1:3000, as you will not be able to grant access to bApps.
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 spec/*
.
To run the tests from the command line:
rspec
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
This will check for any potential JavaScript issues and whether you formatted the code correctly.
Some features of CalCentral are only accessible to users with particular roles, such as student
.
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-212385
ortest-212381
(ask a developer for the passwords to these if you need them). Once logged in as a test student, append/academics
to the URL to access My Academics.
-
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.
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 1-Campus_VPN
.
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
environment.yml
file (e.g.development.yml
):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.
61889
for oski) and then the password from the settings file.
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:
https://[hostname]/act_as?uid=123456
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:
https://[hostname]/stop_act_as
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 filesLOGGER_STDOUT=true
- Log to standard output as well as the default filesLOGGER_STDOUT=only
- Only log to standard outputLOGGER_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:
/Applications/RubyMine.app/Contents/MacOS/rubymine &
-
If you want to explore the Oracle database on Mac OS X, use SQL Developer.
See docs/styleguide.md.
Proxies running in fake mode use WebMock to substitute fixture data for connections to external services (Canvas, Google, etc). This fake data lives in fixtures/json
and fixtures/xml
.
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 -T
rake spec:xml
- Runs rake spec, but pipes the output to xml using therspec_junit_formatter
gem, 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:clear
on the production cluster unless you know what you're doing! -
All
memcached
tasks take the optional param ofhosts
. 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"
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>
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.
The SCSS files under src/assets/stylesheets contain a style of notation known as KSS, which are used to generate a living styleguide via SC-5 Styleguide. See source at Github.
To generate this styleguide run:
gulp styleguide
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.