Switch on logging with a env var

Author: MarcialRosales

selenium/.node-xmlhttprequest-sync-88011

@@ -1,5 +1,6 @@
 var http = require('http'),
     httpProxy = require('http-proxy');
+const {log, error} = require('./utils.js')    
 const XMLHttpRequest = require('xmlhttprequest').XMLHttpRequest
 
 const rabbitmq_url = process.env.RABBITMQ_URL || 'http://0.0.0.0:15672/';
@@ -14,7 +15,7 @@ const port = process.env.PORT;
 var proxy = httpProxy.createProxyServer({});
 
 proxy.on('proxyReq', function(proxyReq, req, res, options) {
-  console.log("proxing " + req.url)
+  log("proxing " + req.url)
   if (req.url.endsWith("bootstrap.js")) {
     proxyReq.setHeader('Authorization', 'Bearer ' + access_token(client_id, client_secret));
   }
@@ -30,7 +31,7 @@ var server = http.createServer(function(req, res) {
     target: rabbitmq_url
   });
 });
-console.log("fakeproxy listening on port " + port + ".  RABBITMQ_URL=" + rabbitmq_url)
+log("fakeproxy listening on port " + port + ".  RABBITMQ_URL=" + rabbitmq_url)
 server.listen(port);
 
 
@@ -51,18 +52,19 @@ function access_token(id, secret) {
     '&token_format=jwt' +
     '&response_type=token';
 
-  console.debug("Sending " + url + " with params "+  params);
+  log("Sending " + url + " with params "+  params);
 
   req.open('POST', url, false);
   req.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
   req.setRequestHeader('Accept', 'application/json');
   req.send(params);
-  console.log("Ret " + req.status)
+  log("Ret " + req.status)
   if (req.status == 200) {
     const token = JSON.parse(req.responseText).access_token;
-    console.log("Token => " + token)
+    log("Token => " + token)
     return token;
   } else {
+    error("Failed to get access token due to " + req.responseText)
     throw new Error(req.status + " : " + req.responseText);
   }
 }

selenium/fakeportal/proxy.js

@@ -1,6 +1,8 @@
 var container = require('rhea')  // https://github.com/amqp/rhea
 var fs = require('fs');
 var path = require('path');
+const {log, error} = require('./utils.js')
+
 var connectionOptions = getConnectionOptions()
 
 function getAmqpConnectionOptions() {
@@ -28,7 +30,7 @@ function getAmqpsConnectionOptions() {
 }
 function getConnectionOptions() {
   let scheme = process.env.RABBITMQ_AMQP_SCHEME || 'amqp'
-  console.log("Using AMQP protocol: " + scheme)
+  log("Using AMQP protocol: " + scheme)
   switch(scheme){
     case "amqp":
       return getAmqpConnectionOptions()

selenium/test/amqp.js

@@ -1,5 +1,5 @@
 const assert = require('assert')
-const { tokenFor, openIdConfiguration } = require('../utils')
+const { log, tokenFor, openIdConfiguration } = require('../utils')
 const { reset, expectUser, expectVhost, expectResource, allow, verifyAll } = require('../mock_http_backend')
 const { open: openAmqp, once: onceAmqp, on: onAmqp, close: closeAmqp } = require('../amqp')
 
@@ -48,11 +48,11 @@ describe('Having AMQP 1.0 protocol enabled and the following auth_backends: ' +
       let oauthProviderUrl = process.env.OAUTH_PROVIDER_URL
       let oauthClientId = process.env.OAUTH_CLIENT_ID
       let oauthClientSecret = process.env.OAUTH_CLIENT_SECRET
-      console.log("oauthProviderUrl  : " + oauthProviderUrl)
+      log("oauthProviderUrl  : " + oauthProviderUrl)
       let openIdConfig = openIdConfiguration(oauthProviderUrl)
-      console.log("Obtained token_endpoint : " + openIdConfig.token_endpoint)
+      log("Obtained token_endpoint : " + openIdConfig.token_endpoint)
       password = tokenFor(oauthClientId, oauthClientSecret, openIdConfig.token_endpoint)
-      console.log("Obtained access token : " + password)
+      log("Obtained access token : " + password)
     }
   })
 
@@ -78,7 +78,7 @@ describe('Having AMQP 1.0 protocol enabled and the following auth_backends: ' +
         closeAmqp(amqp.connection)
       }
     } catch (error) {
-      console.error("Failed to close amqp10 connection due to " + error);      
+      error("Failed to close amqp10 connection due to " + error);      
     }  
   })
 })

selenium/test/authnz-msg-protocols/amqp10.js

@@ -1,6 +1,6 @@
 const fs = require('fs')
 const assert = require('assert')
-const { tokenFor, openIdConfiguration } = require('../utils')
+const { tokenFor, openIdConfiguration, log } = require('../utils')
 const { reset, expectUser, expectVhost, expectResource, allow, verifyAll } = require('../mock_http_backend')
 const mqtt = require('mqtt');
 
@@ -45,9 +45,9 @@ describe('Having MQTT protocol enbled and the following auth_backends: ' + backe
       let oauthClientId = process.env.OAUTH_CLIENT_ID
       let oauthClientSecret = process.env.OAUTH_CLIENT_SECRET
       let openIdConfig = openIdConfiguration(oauthProviderUrl)
-      console.log("Obtained token_endpoint : " + openIdConfig.token_endpoint)
+      log("Obtained token_endpoint : " + openIdConfig.token_endpoint)
       password = tokenFor(oauthClientId, oauthClientSecret, openIdConfig.token_endpoint)
-      console.log("Obtained access token : " + password)
+      log("Obtained access token : " + password)
     }
     mqttOptions = {
       clientId: client_id,

selenium/test/authnz-msg-protocols/mqtt.js

@@ -1,7 +1,7 @@
 const { By, Key, until, Builder } = require('selenium-webdriver')
 require('chromedriver')
 const assert = require('assert')
-const { buildDriver, goToHome, captureScreensFor, teardown, doWhile } = require('../utils')
+const { buildDriver, goToHome, captureScreensFor, teardown, doWhile, log } = require('../utils')
 
 const LoginPage = require('../pageobjects/LoginPage')
 const OverviewPage = require('../pageobjects/OverviewPage')
@@ -56,7 +56,6 @@ describe('Exchange management', function () {
       ["other", "amq.topic", "topic"]
     ]
 
-    console.log("e :" + actual_table)
     assert.deepEqual(actual_table, expected_table)
   })
 

selenium/test/exchanges/management.js

@@ -56,7 +56,7 @@ module.exports = class BasePage {
   }
 
   async clickOnOverviewTab () {
-    return this.click(CONNECTIONS_TAB)
+    return this.click(OVERVIEW_TAB)
   }
 
   async clickOnConnectionsTab () {
@@ -363,9 +363,6 @@ module.exports = class BasePage {
     await this.driver.sleep(250)
     return alert.accept();
   }
-  log(message) {
-    console.log(new Date() + " " + message)
-  }
 
   capture () {
     this.driver.takeScreenshot().then(

selenium/test/pageobjects/BasePage.js

@@ -17,6 +17,7 @@ const hostname = process.env.RABBITMQ_HOSTNAME || 'localhost'
 const seleniumUrl = process.env.SELENIUM_URL || 'http://selenium:4444'
 const screenshotsDir = process.env.SCREENSHOTS_DIR || '/screens'
 const profiles = process.env.PROFILES || ''
+const debug = process.env.DEBUG || false
 
 function randomly_pick_baseurl(baseUrl) {
     urls = baseUrl.split(",")
@@ -46,7 +47,7 @@ class CaptureScreenshot {
 
 module.exports = {
   log: (message) => {
-    console.log(new Date() + " " + message)
+    if (debug) console.log(new Date() + " " + message)
   },
   error: (message) => {
     console.error(new Date() + " " + message)
@@ -103,8 +104,9 @@ module.exports = {
     }
   },
 
-  goToHome: (driver) => {
-    return driver.get(baseUrl)
+  goToHome: (driver, url = baseUrl) => {
+    module.exports.log("goToHome on " + url)
+    return driver.get(url)
   },
 
   goToLogin: (driver, token) => {
@@ -135,16 +137,16 @@ module.exports = {
     let ret
     do {
       try {
-        //console.log("Calling doCallback (attempts:" + attempts + ") ... ")
+        module.exports.log("Calling doCallback (attempts:" + attempts + ") ... ")
         ret = await doCallback()
-        //console.log("Calling booleanCallback (attempts:" + attempts + ") with arg " + ret + " ... ")
+        module.exports.log("Calling booleanCallback (attempts:" + attempts + ") with arg " + ret + " ... ")
         done =  booleanCallback(ret)
       }catch(error) {
-        console.log("Caught " + error + " on doWhile callback...")
+        module.exports.error("Caught " + error + " on doWhile callback...")
 
       }finally {
         if (!done) {
-          //console.log("Waiting until next attempt")
+          module.exports.log("Waiting until next attempt")
           await module.exports.delay(delayMs)
         }
       }     
@@ -179,7 +181,7 @@ module.exports = {
     req.send()
     if (req.status == 200) return JSON.parse(req.responseText)
     else {
-      console.error(req.responseText)
+      module.exports.error(req.responseText)
       throw new Error(req.responseText)
     }
   },
@@ -198,7 +200,7 @@ module.exports = {
     req.send(params)
     if (req.status == 200) return JSON.parse(req.responseText).access_token
     else {
-      console.error(req.responseText)
+      module.exports.error(req.responseText)
       throw new Error(req.responseText)
     }
   },
@@ -215,7 +217,7 @@ module.exports = {
   teardown: async (driver, test, captureScreen = null) => {
     driver.manage().logs().get(logging.Type.BROWSER).then(function(entries) {
         entries.forEach(function(entry) {
-          console.log('[%s] %s', entry.level.name, entry.message);
+          module.exports.log('[%s] %s', entry.level.name, entry.message);
         })
      })
     if (test.currentTest) {
@@ -227,6 +229,14 @@ module.exports = {
       }
     }
     await driver.quit()
+  },
+
+  findTableRow: (table, booleanCallback) => {
+    if (!table) return false
+
+    let i = 0
+    while (i < table.length && !booleanCallback(table[i])) i++;      
+    return i < table.length ? table[i] : undefined
   }
 
 }