Merge branch 'develop' into feature/638_refactor_applications+support_for_color.json

.gitignore

@@ -6,4 +6,11 @@ frontend_app_html-document/dist/html-document.app.js
 frontend_lib/dist/tracim_frontend_lib.js
 npm-debug.log
 package-lock.json
-color.json
+color.json
+
+#ignore file or folder about cypress tests
+functionnal_tests/package.json
+functionnal_tests/cypress.json
+functionnal_tests/node_modules/
+functionnal_tests/cypress/
+

README.md

@@ -2,3 +2,85 @@ develop branch status:
 [![Build Status](https://travis-ci.org/tracim/tracim_v2.svg?branch=develop)](https://travis-ci.org/tracim/tracim_v2)
 [![Coverage Status](https://coveralls.io/repos/github/tracim/tracim_v2/badge.svg?branch=develop)](https://coveralls.io/github/tracim/tracim_v2?branch=develop)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/tracim/tracim_v2/badges/quality-score.png?b=develop)](https://scrutinizer-ci.com/g/tracim/tracim_v2/?branch=develop)
+
+
+## Install Tracim on your server ##
+
+Following the installation documentation below, you'll be able to run your own instance on your server.
+
+----
+
+# Installation #
+
+## Get the source ##
+
+Get the sources from GitHub (you need git):
+
+    git clone https://github.com/tracim/tracim_v2.git
+    cd tracim_v2/
+
+## Install backend
+### Option 1: Install backend manually ###
+
+see [Backend README](backend/README.md)
+
+### Option2: Install backend: Automated script for easy setup ###
+
+This script run backend with simple default conf: development.ini conf file, use
+default config file, sqlite database, etc...
+
+    ./setup_default_backend.sh
+
+For each conf file missing, this script will generated them from default conf.
+If sqlite default database is missing, script will generate it.
+This script is also able to serve for update. If you want to update a script
+generated tracim install, you can just update source code with git pull and
+rerun the same script to update database model, system deps and python deps.
+
+for more information about configuring tracim_backend, see [Backend README](backend/README.md)
+for more information about configuration file, see development.ini.sample documentation
+and [Backend setting file doc](backend/doc/setting.md).
+
+
+## Install frontend: Automated Script for easy setup ##
+
+    ./install_frontend_dependencies.sh
+    ./build_full_frontend.sh
+
+## Running Tracim using pserve ##
+
+    cd backend/
+    source env/bin/activate
+    pserve development.ini
+
+You can now enter the application at
+[http://127.0.0.1:6543](http://127.0.0.1:6543) and login with admin user:
+
+ * user: `admin@admin.admin`
+ * password: `admin@admin.admin`
+
+----
+
+## Running tests with cypress ##
+
+----
+
+## Installation of cypress: Automated script for easy setup ##
+
+This script check if nodejs is installed (npm is necessary to install Cypress), if file package.json and cypress.json exist in 'functionnal_tests' folder. if not the script install necessary file and install Cypress.
+
+    ./install_cypress.sh
+
+## Run tests with command line ##
+
+    cd functionnal_tests/
+    ./node_modules/.bin/cypress run
+
+## Run tests with cypressgui ##
+
+Open Cypress with graphical interface
+
+    cd functionnal_tests/
+    ./node_modules/.bin/cypress open
+
+

backend/development.ini.sample

@@ -12,8 +12,8 @@ pyramid.debug_authorization = false
 pyramid.debug_notfound = false
 pyramid.debug_routematch = false
 pyramid.default_locale_name = en
-pyramid.includes =
-    pyramid_debugtoolbar
+#pyramid.includes =
+#    pyramid_debugtoolbar
 
 [pipeline:webdav]
 pipeline = tracim_webdav
@@ -291,4 +291,4 @@ formatter = generic
 
 [formatter_generic]
 format = %(asctime)s %(levelname)-5.5s [%(name)s:%(lineno)s][%(threadName)s] %(message)s
-datefmt = %H:%M:%S
+datefmt = %H:%M:%S

backend/doc/setting.md

@@ -1,8 +1,13 @@
-# Setting #
+# Settings #
 
-Here is a short description of settings available in the file `development.ini`.
+Here is a short description of settings available in backend config files.
 
-## Listening port ##
+# Tracim config ini file #
+
+This file is called'development.ini' file by default, it's located is backend
+subdir, default config is [development.ini.sample](../development.ini.sample) with some doc.
+
+## Listening port (for pserve only) ##
 
 Default configuration is to listen on port 6534.
 If you want to adapt this to your environment, edit the `.ini` file and setup the port you want:
@@ -17,30 +22,93 @@ To allow other computer to access to this website, listen to "*" instead of loca
     ...
     listen = *:6534
 
-## Prod/Debug configuration ##
+## Database path ##
+
+To configure a database, you need to provide a valid sqlalchemy url:
+
+for sqlite, a valid value is something like this:
+
+    sqlalchemy.url = sqlite:///%(here)s/tracim.sqlite
+
+to know more about this, see [sqlalchemy documentation](http://docs.sqlalchemy.org/en/latest/core/engines.html).
+
+Be carefull, if sqlalchemy support many kind of Database, Tracim support is **not** guarantee.
+Tracim is officially supporting sqlite, postgresql and mysql.
+
+## Debugging and Logs ##
+### Debug params ###
+
+
+For debugging you can uncomment this 2 lines in '/backend/development.ini' to
+enable pyramid debugtoolbar.
+If you use debugtoolbar, you can seen one red button on right of the Tracim web interface.
+
+    ~~~
+    #pyramid.includes =
+    #    pyramid_debugtoolbar
+    ~~~
+
+you can add this line to active pyramid debug mode for almost anything:
+
+    ~~~
+    pyramid.debug_all = true
+    ~~~
+
+
+Hapic debug mode: this line is needed for more explicit json error,
+raised error traceback will be send through json. you can uncomment it
+
+   ~~~
+   # debug = True
+   ~~~
+
+pyramid.reload_templates = true
+
+### Prod/Debug configuration example ###
 
 
 To enable simple debug conf:
 
-    [app:main]
+    [app:tracim_web]
     ...
     pyramid.reload_templates = true
     pyramid.debug_all = true
     pyramid.includes =
         pyramid_debugtoolbar
 
+    [DEFAULT]
+    ...
+    debug = True
+
+
 production conf (no reload, no debugtoolbar):
 
-    [app:main]
+    [app:tracim_web]
     ...
     pyramid.reload_templates = false
     pyramid.debug_authorization = false
     pyramid.debug_notfound = false
     pyramid.debug_routematch = false
 
-You can, of course, also set level of one of the different logger to have more/less log
-about something.
+    [DEFAULT]
+    ...
+    debug = False
+
+You can, of course, also set level of one of the different logger
+to have more/less log about something.
 
     [logger_sqlalchemy]
     ...
     level = INFO
+
+# Color File #
+
+You can change default color of apps by setting color.json file, by default,
+placed at root of tracim_v2 dir, see [color.json.sample](../../color.json.sample)
+for default config file.
+
+# Wsgidav File
+
+This file is by default placed in backend subdir,
+it by default called wsigdav.conf, for more information, see default
+conf file [wsigdav.conf.sample](../wsgidav.conf.sample).

bash_library.sh

@@ -2,8 +2,13 @@
 
 YELLOW='\033[1;33m'
 BROWN='\033[0;33m'
+GREEN='\033[1;32m'
 NC='\033[0m' # No Color
 
 function log {
     echo -e "\n${YELLOW}[$(date +'%H:%M:%S')]${BROWN} $ $1${NC}"
 }
+
+function loggood {
+    echo -e "\n${YELLOW}[$(date +'%H:%M:%S')]${GREEN} $ $1${NC}"
+} 

functionnal_tests/cypress.json.sample

@@ -0,0 +1,6 @@
+{
+  "baseUrl": "http://localhost:6543",
+  "viewportWidth": 1280,
+  "viewportHeight": 1024,
+  "integrationFolder": "{path_test_file}"
+}

functionnal_tests/app_html-document/operation_create_html-document.js → functionnal_tests/cypress_test/app_html-document/operation_create_html-document.js

@@ -33,8 +33,8 @@ describe('operation :: workspace > create_new > html-document', function () {
     it ('all content > header button ', function () {
         var titre2='all content button'
         cy.url().should('include', '/workspaces/1/contents')
-        cy.get('.workspace__header__btnaddcontent').should('be.visible')
-        cy.get('.workspace__header__btnaddcontent').click()
+        cy.get('.workspace__header__btnaddcontent__label').should('be.visible')
+        cy.get('.workspace__header__btnaddcontent__label').click()
         cy.get('.workspace__header__btnaddcontent__setting div:nth-child(4).subdropdown__link').click()
         cy.get('.createcontent .createcontent__contentname').should('be.visible')
         cy.get('.createcontent .createcontent__form__input').should('have.attr', 'placeholder')

install_cypress.sh

@@ -0,0 +1,64 @@
+#!/bin/bash
+ash
+. bash_library.sh # source bash_library.sh
+
+# install nodjs if not installed
+
+(
+  log "Verify if nodjs is installed."
+  dpkg -l | grep '^ii' | grep 'nodejs\s'
+
+  if [ $? -eq 0 ]; then
+    loggood "nodejs is installed."
+  else
+    log "Install nodejs"
+    sudo apt install curl
+    curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
+    sudo apt install -y nodejs
+    loggood "nodejs is now installed."
+  fi
+)
+
+# install Cypress
+log "Go to functionnal_tests subdir.."
+cd  functionnal_tests || exit 1;
+(
+  ACTUALDIR=$(pwd)
+  loggood "Your are now here: \"$ACTUALDIR\""
+  log "Check if package.json exist."
+  if [ ! -f package.json ]; then
+    log "package.json not exist => run npm init"
+    npm init -y
+    loggood "npm init finished => package.json is now created."
+  else
+    loggood "package.json exist."
+  fi
+  log "Install cypress."
+  npm install cypress --save-dev
+  loggood "Cypress is now installed."
+)
+
+# modify cypress.json
+
+(
+  log "Check if cypress.json exist."
+  if [ ! -f cypress.json ]; then
+    log "cypress.json not exist => copy from cypress.json.sample"
+    cp cypress.json.sample cypress.json
+    loggood "cypress.json is now available."
+    log "Write path in cypress.json"
+    SUBDIR=$(pwd)
+    sed -i "s|{path_test_file}|$SUBDIR/cypress_test|g" cypress.json
+    loggood "Path is now configured."
+  else
+  log "cypress.json exist => check if integrationFolder have path."
+    if grep -q "\"integrationFolder\"\:\s\"{path_test_file}\"" cypress.json ; then
+      log "No path => write path in cypress.json"
+      SUBDIR=$(pwd)
+      sed -i "s|{path_test_file}|$SUBDIR|g" cypress.json
+      loggood "Path is now configured."
+    else
+      loggood "Path exist. Modify manualy if necessary."
+    fi
+  fi
+)

install_frontend_dependencies.sh

@@ -3,6 +3,23 @@
 # shellcheck disable=SC1091
 . bash_library.sh # source bash_library.sh
 
+# install nodjs if not installed
+
+(
+  log "verify if nodjs is installed"
+  dpkg -l | grep '^ii' | grep 'nodejs\s'
+
+  if [ $? -eq 0 ]; then
+    log "nodjs is installed"
+  else
+    log "install nodejs"
+    sudo apt install curl
+    curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
+    sudo apt install -y nodejs
+  fi
+)
+
+
 # install Tracim Lib
 
 (