Merge release-5.1.0 into master

.circleci/config.yml

@@ -1,45 +1,68 @@
 version: 2.1
 jobs:
   build:
+    working_directory: ~/generic-editor
     docker:
-      - image: circleci/node:6.10-browsers
+      - image: circleci/node:10.0.0-browsers
         environment:
            version_number: $CIRCLE_BRANCH
            build_number: $CIRCLE_BUILD_NUM
     steps:
-      - checkout
+      - checkout:
+          path: ~/generic-editor
+
       - restore_cache:
           key: dependency-cache-{{ checksum "package.json" }}
 
       - run:
           name: clone plugins
           command: |
-            prnumber=$(echo $CI_PULL_REQUEST | awk -F'/' '{print $NF}')
-            prdata=$(curl -X GET -u $GITHUB_USER_TOKEN:x-oauth-basic https://api.github.com/repos/project-sunbird/sunbird-generic-editor/pulls/$prnumber)
+            if [ -z $CIRCLE_PR_NUMBER ]; then
+            target_branch=$CIRCLE_BRANCH
+            git clone https://github.com/project-sunbird/sunbird-content-plugins.git plugins -b $target_branch
+            else
+            prdata=$(curl -X GET -u $GITHUB_USER_TOKEN:x-oauth-basic https://api.github.com/repos/project-sunbird/sunbird-generic-editor/pulls/$CIRCLE_PR_NUMBER)
             target_branch=$(echo "${prdata}" | jq -r '.base.ref')
             git clone https://github.com/project-sunbird/sunbird-content-plugins.git plugins -b $target_branch
-
-      - run: sudo npm install -g [email protected] [email protected] [email protected] codacy-coverage
+            fi
+
+      - run: sudo npm install -g [email protected] [email protected] [email protected]
       - run: npm install
       - run: cd app && bower cache clean --allow-root
       - run: cd app && bower install --force --allow-root
-      #- run: gulp clone-plugins
       - run: gulp packageCorePlugins
       - run: npm run plugin-build
       - run: npm run build
       - run: npm run test
 
-      - run: cp ./coverage/PhantomJS*/cobertura-coverage.xml /tmp/
+      - run: mkdir -p /tmp/coverage && cp /home/circleci/generic-editor/coverage/lcov/PhantomJS\ 2.1.1\ \(Linux\ 0.0.0\)/lcov.info /tmp/coverage
 
       - store_artifacts:
-          path: /tmp/cobertura-coverage.xml
-          destination: cobertura-coverage.xml
-
+          path: /tmp/coverage
+          destination: coverage
+
+      - run:
+          name: Install NVM
+          command: 'curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh|bash'
+
+      - run:
+          name: alter node version
+          command: 'source ~/.nvm/nvm.sh && nvm install 14 && nvm use 14 && nvm alias default 14 && node -v'
+
+      - run: 
+          name: Install sonar scanner
+          command: 'source ~/.nvm/nvm.sh && sudo npm install -g sonarqube-scanner'
+
+      - run: 
+          name: Sonar scanner
+          command: source ~/.nvm/nvm.sh && sonar-scanner -Dsonar.projectKey=project-sunbird_sunbird-generic-editor -Dsonar.organization=project-sunbird -Dsonar.sources=. -Dsonar.host.url=https://sonarcloud.io -Dsonar.cobertura.reportPath=/coverage/PhantomJS*/cobertura-coverage.xml -Dsonar.language=js
+
       - save_cache:
           key: dependency-cache-{{ checksum "package.json" }}
           paths: ./node_modules
 
 
+
 workflows:
   version: 2.1
   build_and_test:

Jenkinsfile

@@ -20,43 +20,29 @@ node() {
                     sh "cd plugins && git checkout origin/${branch_name} -b ${branch_name}"
                 } else {
                     def scmVars = checkout scm
-                    checkout scm: [$class: 'GitSCM', branches: [[name: "refs/tags/${params.github_release_tag}"]], userRemoteConfigs: [[url: scmVars.GIT_URL]]]
-                    artifact_version = params.github_release_tag
+                    checkout scm: [$class: 'GitSCM', branches: [[name: "${params.github_release_tag}"]], userRemoteConfigs: [[url: scmVars.GIT_URL]]]
                     commit_hash = sh(script: 'git rev-parse --short HEAD', returnStdout: true).trim()
-                    branch_name = params.github_release_tag
+                    artifact_version = params.github_release_tag + "_" + commit_hash
+                    branch_name = params.github_release_tag.split('_')[0].split('\\.')[0] + "." + params.github_release_tag.split('_')[0].split('\\.')[1]
                     println(ANSI_BOLD + ANSI_YELLOW + "github_release_tag specified, building from github_release_tag: " + params.github_release_tag + ANSI_NORMAL)
                     sh "git clone https://github.com/project-sunbird/sunbird-content-plugins.git plugins"
                     sh """
                         cd plugins
-                        checkout_tag=\$(git ls-remote --tags origin release-* | grep -o 'release-.*' | sort -V | tail -n1)
+                        checkout_tag=\$(git ls-remote --tags origin $branch_name* | grep -o "$branch_name.*" | sort -V | tail -n1)
                         git checkout tags/\${checkout_tag} -b \${checkout_tag}
                     """
                 }
                 echo "artifact_version: " + artifact_version
 
                 stage('Build') {
-                    sh """
-                        export version_number=${branch_name}
-                        export build_number=${commit_hash}
-                        rm -rf generic-editor
-                        node -v
-                        npm -v
-                        npm install
-                        cd app
-                        bower cache clean
-                        bower install --force
-                        cd ..
-                        gulp packageCorePlugins
-                        npm run plugin-build
-                        npm run build
-                        #gulp build
-                        npm run test
-                    """
+                    run_testcase = false
+                    sh('chmod 777 build.sh')
+                    sh("bash ./build.sh  ${branch_name} ${commit_hash} ${run_testcase}")
                 }
 
-                stage('Publish_test_results') {
-               cobertura autoUpdateHealth: false, autoUpdateStability: false, coberturaReportFile: 'coverage/PhantomJS*/cobertura-coverage.xml', conditionalCoverageTargets: '70, 0, 0', failUnhealthy: false, failUnstable: false, lineCoverageTargets: '80, 0, 0', maxNumberOfBuilds: 0, methodCoverageTargets: '80, 0, 0', onlyStable: false, sourceEncoding: 'ASCII', zoomCoverageChart: false 
-            }
+            //     stage('Publish_test_results') {
+            //    cobertura autoUpdateHealth: false, autoUpdateStability: false, coberturaReportFile: 'coverage/PhantomJS*/cobertura-coverage.xml', conditionalCoverageTargets: '70, 0, 0', failUnhealthy: false, failUnstable: false, lineCoverageTargets: '80, 0, 0', maxNumberOfBuilds: 0, methodCoverageTargets: '80, 0, 0', onlyStable: false, sourceEncoding: 'ASCII', zoomCoverageChart: false 
+            // }
 
                 stage('ArchiveArtifacts') {
                     sh """

README.md

@@ -4,9 +4,9 @@
 [![npm version](https://badge.fury.io/js/%40project-sunbird%2Fgeneric-editor.svg)](https://badge.fury.io/js/%40project-sunbird%2Fgeneric-editor) [![Build Status](https://travis-ci.org/project-sunbird/sunbird-generic-editor.svg?branch=release-1.11.0)](https://travis-ci.org/project-sunbird/sunbird-generic-editor)
 
 ## Introduction
+The generic editor is used to create contents which can be uploaded as files(H5P, epub, PDF, HTML, Youtube, Video).
 
-Generic editor for all non-ECML contents (H5P, epub, PDF, HTML, Youtube, Video). 
-
+## Configuration
 
 ```js
 window.context = {
@@ -89,12 +89,13 @@ window.config = {
   ],
   corePlugins: [],
   corePluginMapping: {},
-  useProxyForURL: false
+  useProxyForURL: false,
+  cloudStorage: {}
 }
 ```
 
-| Property Name | Description | Default Value   |
-| --- | --- | --- |
+| Property Name | Description | Default Value   | Example |
+| --- | --- | --- | --- |
 | `user` | It is a `object`, Which should contain the user details(userId, name)  | NA  |
 | `sid` | It is a `string`, Session identifier  | NA  |
 | `contentId ` | It is a `string`,  content identifier | NA  |
@@ -107,7 +108,9 @@ window.config = {
 | `pluginRepo ` | It is a `string`, From which location plugins should load  | /plugins  |
 | `dispatcher ` | It is a `string`,Where the telemetry should log ex(console, piwik, library, local) | console |
 | `plugins ` | It is a `array`, Array of plugins ex:`[{id:"org.sunbird.header",ver:"1.0",type:"plugin"}]`| NA |
+| `cloudStorage` |  It is `object` and which defines cloud storage configuration which contains presigned_headers for diff service provider for example: Azure, AWS | ``` cloudStorage: { presigned_headers: { 'x-ms-blob-type': 'BlockBlob' // This header is specific to azure storage provider. } } ``` | The default configuration can be overwrite by passing empty headers. ***For example:*** If you don't want to pass any headers for AWS than pass as empty headers as below: ``` cloudStorage: { presigned_headers: { } } ```
 
+## Integration
 
 ```js
 
@@ -158,4 +161,4 @@ This project is licensed under the MIT License - see the [LICENSE](https://githu
 We use [SemVer](https://semver.org/) for versioning. For the versions available, see the [tags](https://github.com/project-sunbird/sunbird-generic-editor/tags) on this repository.
 
 ## Any Issues?
-We have an open and active [issue tracker](https://project-sunbird.atlassian.net/issues/). Please report any issues.
+We have an open and active [issue tracker](https://project-sunbird.atlassian.net/issues/). Please report any issues.

app/bower.json

@@ -19,7 +19,7 @@
         "oclazyload": "^1.0.9",
         "ngSafeApply": "./libs/Scope.SafeApply.js",
         "izitoast": "^1.1.3",
-        "contenteditor": "https://sunbirddev.blob.core.windows.net/sunbird-content-dev/content-editor/scripts/base-editor.min.js"
+        "contenteditor": "https://sunbirdstagingpublic.blob.core.windows.net/sunbird-content-staging-knowlg/content-editor/scripts/base-editor.min.js"
     },
     "appPath": "app",
     "moduleName": "editorApp",

app/scripts/dev/localhost-ce.js

@@ -13,5 +13,23 @@ window.config = {
     baseURL: "",
     previewURL: "/preview/preview.html",
     apislug: "/action",
-    dispatcher: "local"
+    dispatcher: "local",
+    cloudStorage: {
+      "presigned_headers": {
+        'x-ms-blob-type': 'BlockBlob' // This header is specific to azure storage provider.
+        /* TODO: if more configurations comes for cloud service provider
+           than we have do in more generic way like below:
+           For example:
+           cloudStorage: {
+              provider: 'azure' // azure, aws, etc..
+              azure: {
+                url: 'https://www.azureblogstorage.com'
+                presigned_headers: {
+                  x-ms-blob-type: 'BlockBlob'
+                }
+              }
+           }
+        */
+      }
+    }
 }

app/scripts/genericeditor/genericeditor-config.js

@@ -3,7 +3,9 @@ org.ekstep.contenteditor.config = _.assign(org.ekstep.contenteditor.config, {
 	plugins: [
 		{ 'id': 'org.ekstep.sunbirdcommonheader', 'ver': '1.4', 'type': 'plugin' },
 		{ 'id': 'org.ekstep.metadata', 'ver': '1.1', 'type': 'plugin' },
-		{ 'id': 'org.ekstep.sunbirdmetadata', 'ver': '1.1', 'type': 'plugin' }
+		{ 'id': 'org.ekstep.sunbirdmetadata', 'ver': '1.1', 'type': 'plugin' },
+		{ 'id': 'org.ekstep.uploadlargecontent', 'ver': '1.0', 'type': 'plugin' }
 	],
 	extContWhitelistedDomains: 'youtube.com,youtu.be'
 })
+

auto_build_deploy

@@ -0,0 +1,63 @@
+@Library('deploy-conf') _ 
+node() {
+    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') {
+            tag_name = env.JOB_NAME.split("/")[-1]
+            pre_checks()
+            stage('Checkout') {
+               cleanWs()
+               def scmVars = checkout scm
+               checkout scm: [$class: 'GitSCM', branches: [[name: "refs/tags/$tag_name"]], userRemoteConfigs: [[url: scmVars.GIT_URL]]]
+               commit_hash = sh(script: 'git rev-parse --short HEAD', returnStdout: true).trim()
+               artifact_version = tag_name
+               branch_name = tag_name.split('_')[0].split('\\.')[0] + "." + tag_name.split('_')[0].split('\\.')[1]
+               run_testcase = true
+               sh "git clone https://github.com/project-sunbird/sunbird-content-plugins.git plugins"
+                    sh """
+                        cd plugins
+                        checkout_tag=\$(git ls-remote --tags origin $branch_name* | grep -o "$branch_name.*" | sort -V | tail -n1)
+                        git checkout tags/\${checkout_tag} -b \${checkout_tag}
+                    """
+              }
+                echo "artifact_version: " + artifact_version
+
+          //      stage Build
+                    sh('chmod 777 build.sh')
+                    sh("./build.sh ${branch_name} ${commit_hash} ${run_testcase}") 
+
+
+       //         stage Publish_test_results
+               cobertura autoUpdateHealth: false, autoUpdateStability: false, coberturaReportFile: 'coverage/PhantomJS*/cobertura-coverage.xml', conditionalCoverageTargets: '70, 0, 0', failUnhealthy: false, failUnstable: false, lineCoverageTargets: '80, 0, 0', maxNumberOfBuilds: 0, methodCoverageTargets: '80, 0, 0', onlyStable: false, sourceEncoding: 'ASCII', zoomCoverageChart: false 
+
+
+     //           stage ArchiveArtifacts
+                    sh """
+                        mkdir generic-editor-artifacts
+                        cp generic-editor.zip generic-editor-artifacts
+                        zip -j  generic-editor-artifacts.zip:${artifact_version}  generic-editor-artifacts/*                      
+                    """
+                    archiveArtifacts "generic-editor-artifacts.zip:${artifact_version}"
+                    sh """echo {\\"artifact_name\\" : \\"generic-editor-artifacts.zip\\", \\"artifact_version\\" : \\"${artifact_version}\\", \\"node_name\\" : \\"${env.NODE_NAME}\\"} > metadata.json"""
+                    archiveArtifacts artifacts: 'metadata.json', onlyIfSuccessful: true
+                    currentBuild.description = "${artifact_version}"
+
+        }
+        currentBuild.result = "SUCCESS"    
+        slack_notify(currentBuild.result, tag_name)
+        email_notify()  
+        auto_build_deploy()
+    }
+    catch (err) {
+        currentBuild.result = "FAILURE"
+        slack_notify(currentBuild.result, tag_name)
+        email_notify()
+        throw err
+    }
+
+}

build.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+STARTTIME=$(date +%s)
+NODE_VERSION=10.24.1
+branch_name=$1
+commit_hash=$2
+runTest=$3
+echo "runTest: " $runTest
+echo "Starting editor build from build.sh"
+set -euo pipefail	
+export NVM_DIR="$HOME/.nvm"
+[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"  # This loads nvm
+[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"  # This loads nvm bash_completion
+nvm install $NODE_VERSION
+nvm use $NODE_VERSION
+export version_number=$branch_name
+export build_number=$commit_hash
+rm -rf generic-editor
+sudo apt-get install build-essential libpng-dev
+node -v
+npm -v
+npm install
+cd app
+bower cache clean
+bower install --force
+cd ..
+gulp packageCorePlugins
+npm run plugin-build
+npm run build
+#gulp build
+if [ $runTest == true ]
+then
+    npm run test
+fi

deploy/package.json

@@ -1,6 +1,6 @@
 {
     "name": "generic-editor",
-    "version": "2.4.0",
+    "version": "3.6.0",
     "description": "It is used to update files in deployment job",
     "main": "gulpfile.js",
     "scripts": {

gulpfile.js

@@ -231,6 +231,8 @@ gulp.task('build', ['minify', 'inject', 'replace', 'packageCorePlugins', 'zip'])
 
 var corePlugins = [
     "org.ekstep.uploadcontent-1.5",
+    "org.ekstep.assetbrowser-1.3",
+    "org.ekstep.uploadlargecontent-1.0",
 ]
 
 gulp.task('minifyCorePlugins', function() {
@@ -300,14 +302,14 @@ gulp.task('packageCorePlugins', ["addDir", "minifyCorePlugins"], function() {
             manifest.editor.dependencies.forEach(function(dependency) {
                 var resource = '/content-plugins/' + plugin + '/' + dependency.src;
                 if (dependency.type == 'js') {
-                    fs.appendFile('generic-editor/scripts/coreplugins.js', "org.ekstep.pluginframework.resourceManager.loadExternalResource('" + resource + "', 'js')" + "\n");
+                    fs.appendFile('generic-editor/scripts/coreplugins.js', "org.ekstep.pluginframework.resourceManager.loadExternalResource('" + resource + "', 'js')" + "\n", function(){});
                 } else if (dependency.type == 'css') {
-                    fs.appendFile('generic-editor/scripts/coreplugins.js', "org.ekstep.pluginframework.resourceManager.loadExternalResource('" + resource + "', 'css')" + "\n");
+                    fs.appendFile('generic-editor/scripts/coreplugins.js', "org.ekstep.pluginframework.resourceManager.loadExternalResource('" + resource + "', 'css')" + "\n", function(){});
                 }
             });
         }
         var plugin = fs.readFileSync('plugins/' + plugin + '/editor/plugin.min.js', 'utf8');
-        fs.appendFile('generic-editor/scripts/coreplugins.js', 'org.ekstep.pluginframework.pluginManager.registerPlugin(' + JSON.stringify(manifest) + ',eval(\'' + plugin.replace(/'/g, "\\'") + '\'))' + '\n');
+        fs.appendFile('generic-editor/scripts/coreplugins.js', 'org.ekstep.pluginframework.pluginManager.registerPlugin(' + JSON.stringify(manifest) + ',eval(\'' + plugin.replace(/'/g, "\\'") + '\'))' + '\n', function(){});
     });
     return gulp.src('plugins/**/plugin.min.js', {
         read: false

karmaconf.js

@@ -142,7 +142,8 @@ module.exports = function(config) {
             reporters: [
                 { type: 'html', dir: 'coverage/' },
                 { type: 'text-summary' },
-                { type: 'cobertura' }
+                { type: 'cobertura' },
+                { type: 'lcov', dir: 'coverage/lcov' }
             ],
         }
     })