This repository contains the necessary components to run Philae's e-shop application using Docker. e-shop is an open-cart instance with a fake catalog that has been modified to collect server-side logs as well as per-request code coverage. It is also possible to collect client-side logs by adding an AIFEX script.
First, install Docker
Second,install docker-compose
At the root of the unzipped archive, run the following command:
$ make up
And wait for 30 seconds or so.
To shut down the website, run:
$ make down
Not that this will delete all the containers, including the database. The user logs file is preserved as it is stored on the host machine. If you only want to stop the services, run:
$ make stop
And then to turn them back on, run:
$ make start
The URL to access e-shop is http://localhost:8080.
If for some reason you need to access e-shop from another machine, replace localhost by the IP address of the machine that runs e-shop in files www/html/opencart/config.php and www/html/opencart/admin/config.php.
If you want to use another port, open file docker-compose.yml, go to line 11 "- 8080:80" and change 8080 with the port you wish to use.
The URL of the admin panel is http://localhost:8080/admin
Server-side logs (user action traces) are collected in file www/storage/logs/OpenCartAction.txt
If you want to collect user traces from the client's point of view, create an account on <www.aifex.fr> and start a new AIFEX session. Obtain the sessionId and modelId of your session, and insert the following script in the <head> tag of file /var/www/html/opencart/catalog/view/theme/default/template/common/header.twig:
<script id="AIFEX" connexion-url="https://www.aifex.fr/join?sessionId=######&modelId=#####" src="https://www.aifex.fr/static/AIFEXScript.js" defer=""></script>
Make sure to replace the two # placeholders in the URL by your sessionId and modelId.
Code coverage can be enabled by creating the containers with the following command:
$ make up-cov
Coverage is collected per request by default. After each request, a json file is created in www/html/opencart/codecoverage/coverages and lists, per file, both uncovered lines (value 0) and covered lines (value 1).
It is possible to merge request coverages by first setting the cookie variable test-name to a name of your choosing, then once all requests have been issued, by running:
$ make agg-cov Note that the first time that this command is executed, a Docker image is first created.
The aggregated coverage file (stored at location www/html/opencart/codecoverage/coverages/aggregated) has a slightly different format: for each executed file, it only lists the covered lines, and for each covered line, it mentions which request(s) covered it.
Beware Code coverage files can quickly accumulate and take up a lot of storage space, especially when you don't aggregate the coverage files on a regular basis. To clean all the per-request coverage files, run:
$ make clean
####Client 1
username: [email protected] password: client
####Client 2
username: [email protected] password: client2
####Administrator username: admin password: admin
If images cannot load, try to chmod -R 0777 the www/html/opencart folder.
If e-shop does not start properly and is not reachable, try starting it manually without make, i.e docker-compose up to obtain execution logs.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent