-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
159 lines (137 loc) · 4.76 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/**
* Protractor Google Docs Plugin
*
* Sends info about failed specs to a Google Spreadsheet.
* Namely:
* - For each spec
* - fullName
* - failedExpectations
* - screenshot
* - browserLog
* - For each test suite
* - testName
* - execTime
* - exitCode
*
* For more info see README.md.
*/
'use strict'
const FormData = require('form-data')
const https = require('https')
const yargs = require('yargs')
const imgur = require('imgur')
class GDocsPlugin {
// STATIC
//
// Logs plugin-related errors to console.
static logError() {
const args = Array.prototype.slice.call(arguments)
args.unshift('GDocsPlugin error')
console.error.apply(null, args)
}
constructor() {
this.failedSpecs = []
this.startTime = null
// Jasmine does not allow you to hook promises to its life cycle, causing
// protractor to shut down before you send all your info to GDocs/Imgur.
// By keeping track of all created promises we can hook them to protractor's
// teardown callback.
this.promises = []
}
// PRIVATE
// Translates an object to form-like data for Google Spreadsheet.
_sendData(data) {
return new Promise((resolve) => {
if (!this.config.googleHost) {
throw new Error('host config parameter must be defined')
}
if (!this.config.googlePath) {
throw new Error('path config parameter must be defined')
}
const form = new FormData()
for (const key in data) {
form.append(key, data[key])
}
const request = https.request({
method: 'post',
host: this.config.googleHost,
path: this.config.googlePath,
headers: form.getHeaders()
})
form.pipe(request)
request.on('response', resolve)
})
}
// This callback is not part of ProtractorPlugin API yet (https://github.com/angular/protractor/issues/4007).
// Therefore it must be manually called on protractorConf.afterLaunch
//
// Calculates the time it took for the whole test suite and sends the result to GDocs.
afterLaunch(exitCode) {
return this._sendData({
type: 'execTimes',
testName: yargs.argv.suite,
execTime: Date.now() - this.startTime,
exitCode: exitCode
})
}
// This callback is not part of ProtractorPlugin API yet (https://github.com/angular/protractor/issues/4007).
// Therefore it must be manually called on protractorConf.beforeLaunch
//
// Sets the time for the beginning of the test suite.
beforeLaunch() {
this.startTime = Date.now()
}
// Register all failed tests info:
// - fullName (spec name)
// - failedExpectations
// - screenshot (the imgur link to the uploaded image)
// - browserLog (the current log of the browser)
onPrepare() {
jasmine.getEnv().addReporter({
specDone: (res) => {
if (res.status === 'failed') {
const failedInfo = {
fullName: res.fullName,
failedExpectations: JSON.stringify(res.failedExpectations)
}
this.promises.push(browser.takeScreenshot()
.then(imgur.uploadBase64)
.then((imgurJson) => {
failedInfo.screenshot = imgurJson.data.link
})
.then(() => {
return browser.manage().logs().get('browser')
})
.then((browserLog) => {
failedInfo.browserLog = JSON.stringify(browserLog)
})
.then(() => {
this.failedSpecs.push(failedInfo)
})
.catch(GDocsPlugin.logError))
}
}
})
}
// Sends all failed specs-related data to GDocs.
postResults() {
const sendPromises = []
this.failedSpecs.forEach((failedInfo) => {
sendPromises.push(this._sendData(Object.assign({
type: 'failedSpecs'
}, failedInfo)))
})
return Promise.all(sendPromises)
}
// Set the needed config for GDocs
// config.googleHost - e.g. 'script.google.com'
// config.googlePath - e.g. '/macros/s/123randomNumber456/exec'
setConfig(config) {
this.config = config
}
// Waits for all screenshots to be uploaded.
teardown() {
return Promise.all(this.promises)
}
}
module.exports = new GDocsPlugin()