GitHub

Please note that with MySQL 5.7 and later, the default sql_mode has been changed. Please make sure the following modes are disabled: ONLY_FULL_GROUP_BY, STRICT_TRANS_TABLES, NO_ZERO_IN_DATE, and NO_ZERO_DATE.

Quick Start

If you have docker and docker-compose environment setup on your machine, you can start running iPeer for testing / development quickly by following these steps.

# get the source
git clone https://github.com/ubc/iPeer.git

# change to iPeer directory
cd iPeer

# optionally, checkout the version you wanted to run
# git checkout tags/3.4.4

# pull git submodules
git submodule update --init --recursive

# use the default database config
cp app/config/database.php.default app/config/database.php 

# pull images and start containers
docker-compose pull && docker-compose up -d

# open a shell into the app container
docker exec -it ipeer_app bash
# within the container, install any missing packages
composer install
# exit the container
exit

# on host, change the permission of tmp folders
chmod -R 777 app/tmp
# restart containers
docker-compose restart

Launch a browser and go to http://localhost:8080/ to continue the initial setup.

Running with Docker

Prerequisites

Internet connection
Docker engine and docker-compose installed

Running

Pulling images

Note: if you are planning to do development, you can skip this step.

docker pull ubcctlt/ipeer-app

Edit docker-compose.yml

Edit the docker-compose.yml file and choose the browser for integration tests

- SELENIUM_HOST=selenium-local
- SELENIUM_BROWSER=chrome
#- SELENIUM_BROWSER=firefox

Running iPeer

Note: if you are planning to develop iPeer and did not run docker pull with above commands, you will need to run composer install to install the dependencies and generate database configuration file.

docker-compose up -d

Running iPeer unit tests

Running unit tests within docker containers with phing requires additional libraries to be installed. This can be done by building the ipeer-app image with Dockerfile-app-unittest which is specific for running test cases:
- If the containers are up, stop them by running docker-compose down
- Rebuild the ipeer-app image with the command docker-compose build --no-cache app-unittest
- Start the containers by running docker-compose up -d
To run the unit tests on containers:
- On host, run an interactive shell in the unit test app container: docker exec -it ipeer_app_unittest bash
- In the interactive shell, while at /var/www/html, run the command vendor/bin/phing test

Running integration tests

Install PHP Webdriver (https://github.com/Element-34/php-webdriver) and Sausage (https://github.com/jlipps/sausage) under vendors directory. These are defined as submodules and can be updated by:

   git submodule init
   git submodule update

Setup ubc/docker-canvas container (https://github.com/ubc/docker-canvas). Also create a network bridge to connect the Canvas app and iPeer app containers together

    docker network create canvas_ipeer_network
    docker network connect canvas_ipeer_network ipeer_app
    docker network connect canvas_ipeer_network ipeer_app_unittest
    docker network connect canvas_ipeer_network docker-canvas_app_1

Run the Selenium + Firefox (or Chrome) container (need to disable the passthrough feature):

    docker run -d -p 4444:4444 -e SE_OPTS="-enablePassThrough false" -e TZ="Canada/Pacific" --name selenium-local --shm-size 2g selenium/standalone-firefox:3.7.1-argon

    docker run -d -p 4444:4444 -e SE_OPTS="-enablePassThrough false" -e TZ="Canada/Pacific" --name selenium-local --shm-size 2g selenium/standalone-chrome:3.7.1-argon

Or, if needed to see the browser actions, run the debug image instead and expose the VNC server port 5900 to host:

    docker run -d -p 4444:4444 -p 5900:5900 -e SE_OPTS="-enablePassThrough false" -e TZ="Canada/Pacific" --name selenium-local --shm-size 2g selenium/standalone-firefox-debug:3.7.1-argon

    docker run -d -p 4444:4444 -p 5900:5900 -e SE_OPTS="-enablePassThrough false" -e TZ="Canada/Pacific" --name selenium-local --shm-size 2g selenium/standalone-chrome-debug:3.7.1-argon

To view the browser, run VNC viewer on host (the default password is secret), e.g.: vncviewer localhost::5900

To view the WebDriver Hub status, open the following URL on the host:

    http://localhost:4444/wd/hub

Create a network bridge to connect iPeer, Canvas, and Selenium together

    docker network create canvas_ipeer_network_it
    docker network connect canvas_ipeer_network_it ipeer_app_unittest
    docker network connect canvas_ipeer_network_it ipeer_web_unittest
    docker network connect canvas_ipeer_network_it docker-canvas_app_1
    docker network connect canvas_ipeer_network_it selenium-local

To start the integration test, run an interactive shell in the test app container and run the commands in container, e.g.:

    docker exec -it ipeer_app_unittest bash    # start an interactive shell to run the following commands
    vendor/bin/phing init-test-db    # preload iPeer db with sample data
    cake/console/cake -app app testsuite app group system    # run all system test cases
    cake/console/cake -app app testsuite app case system/studentSimple    # run a specific test case

Running Virtual Development Server

Virtual Environment Setup:

Install VirtualBox at http://virtualbox.org
Install Vagrant at http://www.vagrantup.com/downloads

Go to the iPeer root directory in the terminal. Then run the following commands:

git submodule init
git submodule update
vagrant box add ipeerbox http://developer.nrel.gov/downloads/vagrant-boxes/CentOS-6.4-x86_64-v20130731.box
vagrant plugin install vagrant-vbguest
vagrant up

Go to localhost:2000 in your browser.

Using a different port (the port number must be available on both the virtual and host environment):

change the line in file puppet/dev.pp from
```
 port => 2000,
```

to (eg. port 8888)

    port => 8888,

AND change the line in file app/tests/cases/controllers/v1_controller.test.php from
```
 $server = 'http://localhost:2000';
```

to

    $server = 'http://localhost:8888';

Running Tests:

Go to the iPeer root directory. Then run the following commands vagrant ssh cd /var/www phing test

For more vagrant commands go to http://docs.vagrantup.com/v2/cli/index.html.

Running Tests

Integration Tests

Requirements:

Selenium Server 2.38+
PHP Webdriver (https://github.com/Element-34/php-webdriver)
Firefox

Runing the tests:

cd iPeer
cake/console/cake -app app testsuite app group system

It is better not to touch the mouse or keyboard during the tests.

Configuring Caliper

In order to enable Caliper, both CALIPER_HOST and CALIPER_API_KEY must be set.

CALIPER_HOST: Set the Caliper LRS url.

CALIPER_API_KEY: API key for sending Caliper events to the LRS.

CALIPER_BASE_URL: Optionally set a base url to use for all events. This is useful to help keep statement urls consistent if the url of your instance changes over time or is accessible though different routes (ex http+https or multiple sub-domains). (Uses base url of request by default).

You may optionally override the user default IRI (from $base_url/users/view/$user_id) to something more identifiable when setting both CALIPER_ACTOR_BASE_URL and CALIPER_ACTOR_UNIQUE_IDENTIFIER_PARAM.

CALIPER_ACTOR_BASE_URL: Optionally set the actor's homepage to something else. This will be string formated to allow CALIPER_ACTOR_UNIQUE_IDENTIFIER_PARAM to be inserted into it (use %s where you want the unique identifier to appear). ex: http://www.ubc.ca/%s

CALIPER_ACTOR_UNIQUE_IDENTIFIER_PARAM: Optionally set the actor's unique identifier using any column from the user table (ex: username, id, email). Will be inserted into the CALIPER_ACTOR_BASE_URL string.

iPeer 3.4.9

Fix unsecure form submission when deployed load balancer with SSL offload (#663)
Add github action to build docker
Swich to xdebug 3 config and use env vars instead xdebug.ini
Fix another 502 Bad gateway error related to user page
Fix 502 timeout when adding new event with certain template
Update Guard plugin to 1.0.8
Merge pull request #665 from josephkh/567-mixed-evaluation-ordering
Fixed the order of questions in mixed evaluation in students view
Fix issue with the functionality of exporting to PDF
Change String::tokenize to CakeString::tokenize
Add pdo_mysql to dockerfile
Better detection of https requests

iPeer 3.4.8

Fix a bug preventing instructor adding survey based event

iPeer 3.4.7

Increase PHP memory limit for docker container
Fix logging issue for docker container

iPeer 3.4.6

FIX mixeval edit (#660)
Update cake-guard to 1.0.7 to support eldap
Fix docker-compose build (#645)
Update cake-guard to 1.0.6
Update composer deps
Fix mixed content issue
Fix fresh installation and simplify Dockerfile and docker-compose
Redirect ipeer logs to stdout/stderr and optimize composer
Update readme.md
Update readme.md
Caliper session hashing (#636)
Caliper v1p2 update
Merge pull request #631 from ubc/fix-tests
Fix events model test
Add steps on how to run test cases in containers

iPeer 3.4.5

Skip this version. Failed release

iPeer 3.4.4

Added Caliper and delayed jobs support
Utilize Canvas's new gradebook Posting Policy
Add term field to courses.

After deployment, login to the url /upgrade as administrator to upgrade the DB. Otherwise users won't be able to load the homepage.

iPeer 3.4.3

Fix problems with instructors not able to copy evaluation templates

iPeer 3.4.2

Fix problems with Simple Evaluations page not displayed properly

iPeer 3.4.1

Fix problems with the emailer

iPeer 3.4.0

Update iPeer to run under PHP 7.2.

iPeer 3.3.4

Fixed the problem of not importing group membership from Canvas when all group members are new iPeer users.
Display course term next to course name when selecting Canvas courses for import
Add purpose/description to the Canvas access token

iPeer 3.3.3

Fixed the problem of new users created with role=0 when importing groups with Canvas
Fixed #596 import student number from Canvas sis_user_id

iPeer 3.3.2

Simplify Canvas group import and export
Import instructors and TAs (as instructors) from Canvas when importing users
For Mixed evaluation, clear the comment field if the question type is graded Likert or ScoreDropdown (#565)

iPeer 3.3.1

Push Evaluation Grades to Canvas

iPeer 3.3.0

Updated UI/UX to make iPeer more modern
Added Canvas integration
Fixed grades api for mixed eval
Fixed edit event template issue

iPeer 3.2.0

Fixed wrong score calculation when using rubric with zero mark enabled
Validated Rubric and Mixeval form data
Fixed #532 permission issue when re-add user
Fixed empty email body when there is no special merge field
Commented out volume mount for ipeer app docker image
Fixed the permission issue in docker image
Added docker instructions to readme
Added image directive in docker-compose
Added AWS deployment script
Added a simple health endpoint
Added deployment instruction/scripts for GCE
Removed config dir and database writable checking
More strict checking for env vars
Updateed build.xml and travis.yml to use environment vars
Set default Session.model value
Added web container for static file serving
Updated cake guard
Used table to detect installation and refactor installation
Added docker support
Updated translation file
Updated deployment script for travis

iPeer 3.1.9

Fixed #527 wrong grades calculated during the grade through API
Updated guard template file to guard_default.php
Fixed #530 CI tests
Fixed System Parameter unit test
Fixed #526 Sections will be submitted automatically before the evaluation is submitted
Added travis CI support
Added course creation instructions system parameter
Merge pull request #519 from ubc/andrew-3.1.x
Merge pull request #521 from ubc/448-3.1.x
Merge pull request #520 from ubc/491-3.1.x
Fixed #448 - Rubric evaluation form has accordion closed by default
Added permissions for event/export and event/import in delta 11
Event CSV import date format restriction loosened (will use any date string with compatible with strtotime function) - Fixed testCsvExport unit test data
Fixed a range calculation issue with the getPenaltyByPenaltiesAndDaysLate function (added case to unit tests)
Fixed #517 - Simple Eval and Mixed Eval now take into account penalties for students who do not submit their evaluations
Improved Performance on PDF export although it still takes a long time
Improved performance to export CSV
Improved performance for simpleEvalScore and mixedEvalScore by removing the unneeded associated results from the query (no longer requires paging) - Further improved performance for rubricEvalScore by only fetching the EvaluationRubricDetail association (event is not needed) - Added some documentation to rubricEvalScore for why it is fetching in chunks
Improved performance for simpleEvalScore, mixedEvalScore, and rubricEvalScore functions to handle larger class sizes
Improved general performance for Grades API
Added new function getPenaltyByPenaltiesAndDaysLate to Penalty model with unit tests
Fixed issues with installation steps for Vagrant and Puppet
Moved guard into composer
Switched mayflower php module
Added missing fixtures
Fixed #491 Implemented event import and export
Fixed emails templates filling in wrong names.
Added ipeer_test database to puppet dev.pp

iPeer 3.1.8

Fixed #494 the incorrect timezone adjustment
Removed result release date from survey event view
Fixed #508, Extract only model,view and controller for i18n
Fixed the issue that no event listed when user has dual roles
Allowed partial submission for rubric eval
Added composer
Changed criteria comment field in evaluation_rubric_details to text
Fixed wrong calculation in grade API
Fixed missing student in eval when he/she has non student role