blob: 4036e7917deb5a715aadb8d84cafded4597cf5e2 [file] [log] [blame]
Matteo Scandolod2044a42017-08-07 16:08:28 -07001
2/*
3 * Copyright 2017-present Open Networking Foundation
4
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8
9 * http://www.apache.org/licenses/LICENSE-2.0
10
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18
Matteo Scandolobba1d782016-07-12 15:56:23 -070019'use strict';
20
21// BUILD
22//
23// The only purpose of this gulpfile is to build a XOS view and copy the correct files into
24// .html => dashboards
25// .js (minified and concat) => static/js
26//
27// The template are parsed and added to js with angular $templateCache
28
29var gulp = require('gulp');
30var ngAnnotate = require('gulp-ng-annotate');
31var uglify = require('gulp-uglify');
32var templateCache = require('gulp-angular-templatecache');
33var runSequence = require('run-sequence');
34var concat = require('gulp-concat-util');
35var del = require('del');
36var wiredep = require('wiredep');
37var angularFilesort = require('gulp-angular-filesort');
38var _ = require('lodash');
39var eslint = require('gulp-eslint');
40var inject = require('gulp-inject');
41var rename = require('gulp-rename');
42var replace = require('gulp-replace');
43var postcss = require('gulp-postcss');
44var autoprefixer = require('autoprefixer');
45var mqpacker = require('css-mqpacker');
46var csswring = require('csswring');
Matteo Scandolo262385f2016-08-08 09:28:14 -070047var yaml = require('js-yaml');
48var colors = require('colors/safe');
49var fs = require('fs');
Matteo Scandolobba1d782016-07-12 15:56:23 -070050
51const TEMPLATE_FOOTER = `
52angular.module('xos.dashboardManager')
53.run(['$location', function(a){
54 a.path('/');
55}])
56`
57
58module.exports = function(options){
59
60 // delete previous builded file
61 gulp.task('clean', function(){
62 return del(
63 [
64 options.dashboards + 'xosDashboardManager.html',
Matteo Scandolo195dde92016-07-25 16:43:16 -070065 options.static + 'css/xosDashboardManager.css',
66 options.static + 'images/dashboardManager-icon.png',
67 options.static + 'images/dashboardManager-icon-active.png'
Matteo Scandolobba1d782016-07-12 15:56:23 -070068 ],
69 {force: true}
70 );
71 });
72
73 // minify css
74 gulp.task('css', function () {
75 var processors = [
76 autoprefixer({browsers: ['last 1 version']}),
77 mqpacker,
78 csswring
79 ];
80
81 gulp.src([
82 `${options.css}**/*.css`,
83 `!${options.css}dev.css`
84 ])
85 .pipe(postcss(processors))
86 .pipe(gulp.dest(options.tmp + '/css/'));
87 });
88
89 // copy css in correct folder
90 gulp.task('copyCss', ['wait'], function(){
91 return gulp.src([`${options.tmp}/css/*.css`])
92 .pipe(concat('xosDashboardManager.css'))
93 .pipe(gulp.dest(options.static + 'css/'))
94 });
95
Matteo Scandolo195dde92016-07-25 16:43:16 -070096 // copy images in correct folder
97 gulp.task('copyImages', ['wait'], function(){
Matteo Scandolo262385f2016-08-08 09:28:14 -070098 return gulp.src([`${options.icon}/dashboardManager-icon.png`, `${options.icon}/dashboardManager-icon-active.png`])
Matteo Scandolo195dde92016-07-25 16:43:16 -070099 .pipe(gulp.dest(options.static + 'images/'))
100 });
101
Matteo Scandolobba1d782016-07-12 15:56:23 -0700102 // compile and minify scripts
103 gulp.task('scripts', function() {
104 return gulp.src([
105 options.tmp + '**/*.js'
106 ])
107 .pipe(ngAnnotate())
108 .pipe(angularFilesort())
109 .pipe(concat('xosDashboardManager.js'))
110 .pipe(concat.header('//Autogenerated, do not edit!!!\n'))
111 .pipe(concat.footer(TEMPLATE_FOOTER))
112 .pipe(uglify())
113 .pipe(gulp.dest(options.static + 'js/'));
114 });
115
116 // set templates in cache
117 gulp.task('templates', function(){
118 return gulp.src('./src/templates/*.html')
119 .pipe(templateCache({
120 module: 'xos.dashboardManager',
121 root: 'templates/'
122 }))
123 .pipe(gulp.dest(options.tmp));
124 });
125
126 // copy html index to Django Folder
127 gulp.task('copyHtml', function(){
128 return gulp.src(options.src + 'index.html')
129 // remove dev dependencies from html
130 .pipe(replace(/<!-- bower:css -->(\n^<link.*)*\n<!-- endbower -->/gmi, ''))
131 .pipe(replace(/<!-- bower:js -->(\n^<script.*)*\n<!-- endbower -->/gmi, ''))
132 // injecting minified files
133 .pipe(
134 inject(
135 gulp.src([
Matteo Scandolo195dde92016-07-25 16:43:16 -0700136 options.static + 'vendor/xosDashboardManagerVendor.js',
Matteo Scandolobba1d782016-07-12 15:56:23 -0700137 options.static + 'js/xosDashboardManager.js',
138 options.static + 'css/xosDashboardManager.css'
139 ]),
140 {ignorePath: '/../../../xos/core/xoslib'}
141 )
142 )
143 .pipe(rename('xosDashboardManager.html'))
144 .pipe(gulp.dest(options.dashboards));
145 });
146
147 // minify vendor js files
148 gulp.task('wiredep', function(){
149 var bowerDeps = wiredep().js;
150 if(!bowerDeps){
151 return;
152 }
153
154 // remove angular (it's already loaded)
155 _.remove(bowerDeps, function(dep){
156 return dep.indexOf('angular/angular.js') !== -1;
157 });
158
159 return gulp.src(bowerDeps)
160 .pipe(concat('xosDashboardManagerVendor.js'))
161 .pipe(uglify())
Matteo Scandolo195dde92016-07-25 16:43:16 -0700162 .pipe(gulp.dest(options.static + 'vendor/'));
Matteo Scandolobba1d782016-07-12 15:56:23 -0700163 });
164
165 gulp.task('lint', function () {
166 return gulp.src(['src/js/**/*.js'])
167 .pipe(eslint())
168 .pipe(eslint.format())
169 .pipe(eslint.failAfterError());
170 });
171
172 gulp.task('wait', function (cb) {
173 // setTimeout could be any async task
174 setTimeout(function () {
175 cb();
176 }, 1000);
177 });
178
Matteo Scandolo262385f2016-08-08 09:28:14 -0700179 gulp.task('tosca', function (cb) {
180
181 // TOSCA to register the dashboard in the system
182 const dashboardJson = {};
183 dashboardJson['DashboardManager'] = {
184 type: 'tosca.nodes.DashboardView',
185 properties: {
186 url: 'template:xosDashboardManager'
187 }
188 };
189
190 // check for custom icons
191 if(
192 fs.existsSync(`${options.icon}/dashboardManager-icon.png`) &&
193 fs.existsSync(`${options.icon}/dashboardManager-icon-active.png`)
194 ){
195 dashboardJson['DashboardManager'].properties.custom_icon = true;
196 }
197
198 const dashboardTosca = yaml.dump(dashboardJson).replace(/'/gmi, '');
199
200 // TOSCA to add the dashboard to the user
201 const userDashboardJson = {};
202 userDashboardJson['dashboardManager_dashboard'] = {
203 node: 'DashboardManager',
204 relationship: 'tosca.relationships.UsesDashboard'
205 };
206 const userJson = {
207 'padmin@vicci.org': {
208 type: 'tosca.nodes.User',
209 properties: {
210 'no-create': true,
211 'no-delete': true
212 },
213 requirements: [userDashboardJson]
214 }
215 };
216 const userTosca = yaml.dump(userJson).replace(/'/gmi, '');
217
218
219 // the output is in a timeout so that it get printed after the gulp logs
220 setTimeout(function () {
221 console.log(colors.cyan('\n\n# You can use this recipe to load the dashboard in the system:'));
222 console.log(colors.yellow(dashboardTosca));
223 console.log(colors.cyan('# And this recipe to activate the dashboard for a user:'));
224 console.log(colors.yellow(userTosca));
225 }, 1000);
226 cb();
227 });
228
Matteo Scandolobba1d782016-07-12 15:56:23 -0700229 gulp.task('build', function() {
230 runSequence(
231 'clean',
232 'sass',
233 'templates',
234 'babel',
235 'scripts',
236 'wiredep',
237 'css',
238 'copyCss',
Matteo Scandolo195dde92016-07-25 16:43:16 -0700239 'copyImages',
Matteo Scandolobba1d782016-07-12 15:56:23 -0700240 'copyHtml',
Matteo Scandolo262385f2016-08-08 09:28:14 -0700241 'cleanTmp',
242 'tosca'
Matteo Scandolobba1d782016-07-12 15:56:23 -0700243 );
244 });
245};