Dial assemble

.circleci/config.yml

@@ -1,3 +1,4 @@
+
 version: 2.1
 jobs:
   build:
@@ -8,7 +9,6 @@ jobs:
       - run:
           name: run build file
           command: /bin/bash -x build.sh ${CIRCLE_SHA1} test
-
   test-cases:
     working_directory: ~/portal/src/app/client
     docker:
@@ -34,16 +34,13 @@ jobs:
           name: Executing test cases
           command: 'npm run test-coverage | tee /tmp/logs/test_cases.log'
       - run:
-          name: Publishing report to Codacy
-          command: 'npm install -g codacy-coverage && cat ./coverage/lcov.info | codacy-coverage '
-          when: always
-      - store_artifacts:
-          path: /tmp/logs
-          destination: logs
-
+          name: install sonar scanner
+          command: npm install -g sonarqube-scanner
+      - run:
+         name: run sonar scanner
+         command: 'cd ~/portal && sonar-scanner'
 workflows:
   version: 2
   build_and_test:
     jobs:
-      #- build
       - test-cases

.gitignore

@@ -9,5 +9,8 @@ mochawesome-report
 /npm-debug.log
 .coverrun
 /src/app/log
-
-
+/src/app/.nyc_output
+/src/app/coverage
+.idea
+/src/app/helpers/devConfig.js
+/.vscode/launch.json

Dockerfile

@@ -1,5 +1,5 @@
 # Dockerfile for the player setup
-FROM node:8.11-slim
+FROM node:12.16.1-slim
 RUN useradd -u 1001 -md /home/sunbird sunbird
 WORKDIR /home/sunbird
 COPY --chown=sunbird /src/app/app_dist/ /home/sunbird/app_dist/

Dockerfile.Build

@@ -1,11 +1,11 @@
 #Dockerfile for the player setup
-FROM node:8.11.0
+FROM node:12.16.1
 MAINTAINER "Rajesh Rajendran <rajesh.r@optit.co>"
 RUN sed -i '/jessie-updates/d' /etc/apt/sources.list
 RUN apt-get update && apt-get install -y --no-install-recommends apt-utils \
     && apt-get install -y --force-yes python python-dev autoconf g++ make nasm bzip2 \
     && useradd jenkins
-RUN npm i -g npm@3.10.10
+RUN npm i -g npm@6.13.4
 RUN mkdir -p /home/jenkins
 WORKDIR /home/jenkins
 COPY * /home/jenkins/

Jenkinsfile

@@ -20,14 +20,14 @@ node('build-slave') {
                     checkout scm
                     commit_hash = sh(script: 'git rev-parse --short HEAD', returnStdout: true).trim()
                     branch_name = sh(script: 'git name-rev --name-only HEAD | rev | cut -d "/" -f1| rev', returnStdout: true).trim()
-                    build_tag = branch_name + "_" + commit_hash
+                    build_tag = branch_name + "_" + commit_hash + "_" + env.BUILD_NUMBER
                     // Creating artifact version
                     artifact_version = branch_name + "_" + commit_hash
                     println(ANSI_BOLD + ANSI_YELLOW + "github_release_tag not specified, using the latest commit hash: " + commit_hash + ANSI_NORMAL)
                 } else {
                     def scmVars = checkout scm
                     checkout scm: [$class: 'GitSCM', branches: [[name: "refs/tags/$params.github_release_tag"]], userRemoteConfigs: [[url: scmVars.GIT_URL]]]
-                    build_tag = params.github_release_tag
+                    build_tag = params.github_release_tag + "_" + env.BUILD_NUMBER
                     // Creating artifact version
                     commit_hash = sh(script: 'git rev-parse --short HEAD', returnStdout: true).trim()
                     branch_name = sh(script: 'git name-rev --name-only HEAD | rev | cut -d "/" -f1| rev', returnStdout: true).trim()

auto_build_deploy

@@ -0,0 +1,50 @@
+@Library('deploy-conf') _ 
+node('build-slave') {
+    try {
+        String ANSI_GREEN = "\u001B[32m"
+        String ANSI_NORMAL = "\u001B[0m"
+        String ANSI_BOLD = "\u001B[1m"
+        String ANSI_RED = "\u001B[31m"
+        String ANSI_YELLOW = "\u001B[33m"
+
+        ansiColor('xterm') {
+            timestamps {
+                tag_name = env.JOB_NAME.split("/")[-1]
+                pre_checks()
+                stage('Checkout') {
+                    if (!env.hub_org) {
+                        println(ANSI_BOLD + ANSI_RED + "Uh Oh! Please set a Jenkins environment variable named hub_org with value as registery/sunbidrded" + ANSI_NORMAL)
+                        error 'Please resolve the errors and rerun..'
+                    } else
+                        println(ANSI_BOLD + ANSI_GREEN + "Found environment variable named hub_org with value as: " + hub_org + ANSI_NORMAL)
+//                cleanWs()
+                  def scmVars = checkout scm
+                  checkout scm: [$class: 'GitSCM', branches: [[name: "refs/tags/$tag_name"]], userRemoteConfigs: [[url: scmVars.GIT_URL]]]
+                  build_tag = tag_name + "_" + env.BUILD_NUMBER
+                  commit_hash = sh(script: 'git rev-parse --short HEAD', returnStdout: true).trim()
+                  branch_name = sh(script: 'git name-rev --name-only HEAD | rev | cut -d "/" -f1| rev', returnStdout: true).trim()
+                  artifact_version = branch_name + "_" + commit_hash
+                }
+                echo "build_tag: " + build_tag
+
+         //       stage Build
+                    sh("./build.sh ${build_tag} ${env.NODE_NAME} ${hub_org} ${env.content_editor_url} ${env.collection_editor_url} ${env.generic_editor_url}")
+
+
+          //      stage ArchiveArtifacts
+                    archiveArtifacts "metadata.json"
+                    currentBuild.description = "${build_tag}"
+            }
+        }
+        currentBuild.result = "SUCCESS"    
+        slack_notify(currentBuild.result, tag_name)
+        email_notify()  
+        auto_build_deploy_player()   
+    }
+    catch (err) {
+        currentBuild.result = "FAILURE"
+        slack_notify(currentBuild.result, tag_name)
+        email_notify()
+        throw err
+    }
+}

build.sh

@@ -16,22 +16,22 @@ commit_hash=$(git rev-parse --short HEAD)
 
 rm -rf src/app/app_dist/
 rm -rf src/app/player-dist.tar.gz
-nvm install 8.11
-nvm use 8.11
+nvm install 12.16.1
+nvm use 12.16.1
 cd src/app
 npm set progress=false
 npm install  --unsafe-perm
 npm run deploy
 cd app_dist
-npm i -g npm@3.10.10
+npm i -g npm@6.13.4
 npm install --production  --unsafe-perm
 sed -i "/version/a\  \"buildHash\": \"${commit_hash}\"," package.json
 echo 'Compressing assets directory'
 cd ..
 tar -cvf player-dist.tar.gz app_dist
 cd ../..
 
-docker build --label commitHash=$(git rev-parse --short HEAD) -t ${org}/${name}:${build_tag} .
+docker build --no-cache --label commitHash=$(git rev-parse --short HEAD) -t ${org}/${name}:${build_tag} .
 
 echo {\"image_name\" : \"${name}\", \"image_tag\" : \"${build_tag}\",\"commit_hash\" : \"${commit_hash}\", \"node_name\" : \"$node\"} > metadata.json
 

sonar-project.properties

@@ -0,0 +1,10 @@
+sonar.projectName=SunbirdEd-portal
+sonar.language=ts
+sonar.sources=src/app/client/src
+#sonar.tests=src/app/client/src/app/
+sonar.exclusions=src/assets/**,src/app/client/src/assets/**,src/thidparty/**,src/app/modules/offline/**,src/app/client/src/**/*.spec.ts,src/app/client/src/**/*.spec.data.ts,src/app/client/src/**/*.module.ts
+sonar.typescript.lcov.reportPaths=/root/portal/src/app/client/coverage/lcov.info
+sonar.projectKey=Sunbird-Ed_SunbirdEd-portal
+sonar.host.url=https://sonarcloud.io
+sonar.organization=sunbird-ed
+sonar.projectVersion=1.0

src/app/client/README.md

@@ -1,27 +1,180 @@
-# Src
+# Installing Sunbird Portal
 
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 1.6.7.
+Installing Sunbird requires two primary software components:
 
-## Development server
+- Sunbird portal or web application
+- Sunbird services stack or the backend API interface
 
-Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
+## Table of contents
 
-## Code scaffolding
+- [Prerequisites](#prerequisites)
+- [Project Setup](#project-setup)
+- [Running Application](#running-application)
+- [Project Structure](#project-structure)
+- [Testing](#testing)
+---
 
-Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+### Prerequisites
 
-## Build
+<table>
+  <tr>
+    <td colspan="2"><b>System Requirements</b></td>
+  </tr>
+  <tr>
+    <td><b>Operating System</b></td>
+    <td>Windows 7 and above/4.2 Mac OS X 10.0 and above/Linux</td>
+  </tr>
+  <tr>
+    <td><b>RAM</b></td>
+    <td>> 1.5 Gb</td>
+  </tr>
+  <tr>
+    <td><b>CPU</b></td>
+    <td>2 cores, > 2 GHz</td>
+  </tr>
+</table>
 
-Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.
 
-## Running unit tests
+| Software dependencies |  |
+| :--- | ------- |
+| **[Node](https://nodejs.org/en/download/)** | > 8.x.x (Install the latest release of LTS version) |
+| **[Gulp](https://github.com/gulpjs/gulp/blob/master/docs/getting-started/1-quick-start.md)** | Latest version of gulp: `npm install -g gulp-cli` |
+| **[nodemon](https://www.npmjs.com/package/nodemon)** | Latest version  of nodemon: `npm install -g nodemon` |
 
-Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
 
-## Running end-to-end tests
+### Project Setup
 
-Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
+1. Clone project
 
-## Further help
+    ```console
+    git clone https://github.com/Sunbird-Ed/SunbirdEd-portal.git
+    ```
+
+    > ***Note***: Stable versions of the sunbird portal are available via tags for each release, and the master branch contains latest stable release. For latest stable release [refer](https://github.com/Sunbird-Ed/SunbirdEd-portal/branches)
+
+2. Add the following environment variables - *Required for downloading editors (Via gulp task)*
+
+      ```console
+      export sunbird_content_editor_artifact_url="https://sunbirddev.blob.core.windows.net/sunbird-content-dev/artefacts/editor/content-editor-iframe-2.6.0.zip"
+
+      export sunbird_collection_editor_artifact_url="https://sunbirddev.blob.core.windows.net/sunbird-content-dev/artefacts/editor/collection-editor-iframe-2.6.0.zip"
+
+      export sunbird_generic_editor_artifact_url="https://sunbirddev.blob.core.windows.net/sunbird-content-dev/artefacts/editor/generic-editor-iframe-2.6.0.zip"
+      ```
+
+3. Install required dependencies
+
+    1. Sunbird portal or web application
+
+        1. $ cd {PROJECT-FOLDER}/src/app/client
+        2. $ npm install
+
+    2. Sunbird services stack or the backend API interface
+
+        1. $ gulp download:editors
+        2. $ cd {PROJECT-FOLDER}/src/app
+        3. $ npm install
+
+4. Configuring the Environment and Services Stack
+
+    > Configure the following system environment variables in the terminal which you have opened
+
+          | Environment Variable      |  Value  | Data Type |
+          | :------------------------ | ------- | --------- |
+          |  sunbird_environment      | local   |   string  |
+          |  sunbird_instance         | sunbird |   string  |
+          |  sunbird_default_channel  | sunbird |   string  |
+          |  sunbird_default_tenant   | sunbird |   string  |
+
+    > The initialization of these environmental variables can take place in a common place like in your **.bashrc** or **.bash_profile**
+
+5. Edit the Application Configuration
+
+    > Open `<PROJECT-FOLDER>/src/app/helpers/environmentVariablesHelper.js` in any available text editor and update the contents of the file so that it contains exactly the following values
+
+      ```console
+          module.exports = {
+              // 1. LEARNER_URL   
+              LEARNER_URL: env.sunbird_learner_player_url || <'https://<host for adopter's instance>',
+
+              // 2. CONTENT_URL
+              CONTENT_URL: env.sunbird_content_player_url || <'https://<host for adopter's instance>',
+
+              // 3. CONTENT_PROXY  
+              CONTENT_PROXY_URL: env.sunbird_content_proxy_url || <'https://<host for adopter's instance>',
+              PORTAL_REALM: env.sunbird_portal_realm || 'sunbird',
+
+              // 4. PORTAL_AUTH_SERVER_URL
+              PORTAL_AUTH_SERVER_URL: env.sunbird_portal_auth_server_url || <'https://<host for adopter's instance>',
+              PORTAL_AUTH_SERVER_CLIENT: env.sunbird_portal_auth_server_client || "portal",
+              ...
+              PORTAL_PORT: env.sunbird_port || 3000,
+
+              // 5. PORTAL_API_AUTH_TOKEN
+              PORTAL_API_AUTH_TOKEN: env.sunbird_api_auth_token || User generated API auth token
+              ...
+
+              // 6. PORTAL_ECHO_API_URL
+              PORTAL_ECHO_API_URL: env.sunbird_echo_api_url || '',
+              ...
+          }
+      ```
+
+    > Once the file is updated with appropriate values, then you can proceed with running the application
+
+### Running Application
+
+1. Sunbird portal or web application
+
+    1. Run the following command in the **{PROJECT-FOLDER}/src/app/client** folder
+    2. $ nodemon
+    3. Wait for the following message before proceeding to the next step 
+        ```
+        [nodemon] clean exit - waiting for changes before restart
+        ```
+
+2. Sunbird services stack or the backend API interface
+
+    1. Run the following command in the **{PROJECT-FOLDER}/src/app** folder
+    2. $ node server.js
+
+3. The local HTTP server is launched at `http://localhost:3000`
+
+### Project Structure
+
+    .
+    ├── Sunbirded-portal                                            
+    |   ├── /.circleci                           # 
+    │   |   └── config.yml                       # Circleci Configuration file
+    |   ├── /experiments                         # -|-
+    |   ├── /src/app                             # Sunbird portal or web application
+    │   |   ├── /client                          # -|-
+    │   |   |    └── src                         # -|-
+    │   |   ├── /helpers                         # Helpers and Service file
+    │   |   ├── /libs                            # Sunbird utilities
+    │   |   ├── /proxy                           # Redirection to respective services
+    │   |   ├── /resourcebundles                 # Language resources
+    │   |   ├── /routes                          # Sunbird Backend Routes
+    │   |   ├── /sunbird-plugins                 # Sunbird plugins for editors
+    │   |   ├── /tests                           # Test case scripts for helpers and routes
+    │   |   ├── framework.config.js              # Default framework configuration
+    │   |   ├── gulp-tenant.js                   # -|-
+    │   |   ├── gulpfile.js                      # Gulp build configuration
+    │   |   ├── package.json                     # Contains Node packages as specified as dependencies in package.json
+    │   |   └── server.js                        # Main application program file / entry file for Sunbird services stack or the backend API interface
+    └───└── .gitignore                           # git configuration to ignore some files and folder
+
+### Testing
+
+1. Sunbird portal or web application
+
+        1. $ cd {PROJECT-FOLDER}/src/app/client
+        2. $ npm run test
+        3. With Coverage $ npm run test-coverage
+
+2. Sunbird services stack or the backend API interface
+
+        1. $ cd {PROJECT-FOLDER}/src/app
+        2. $ npm run backend-test
+        3. With Coverage $ npm run backend-test-with-coverage
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).