Fix issue #7369

Depending on `disable_stats` value
search for detailed exchange details or
basic details

Author: MarcialRosales

deps/rabbitmq_management/priv/www/js/tmpl/exchanges.ejs

@@ -1,8 +1,8 @@
 <h1>Exchanges</h1>
-<div class="section">
+<div class="section" id="exchanges-paging-section">
    <%= paginate_ui(exchanges, 'exchanges') %>
-</div> 
-<div class="updatable">
+</div>
+<div class="updatable" id="exchanges-table-section">
 <% if (exchanges.items.length > 0) { %>
 <table class="list">
  <thead>
@@ -84,7 +84,7 @@
   </div>
 </div>
 
-<div class="section-hidden">
+<div class="section-hidden" id="add-new-exchange">
   <h2>Add a new exchange</h2>
   <div class="hider">
     <form action="#/exchanges" method="put">

deps/rabbitmq_management/selenium/suites/exchanges.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+SCRIPT="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+# Name of the suite used to generate log and screen folders
+SUITE=$( basename "${BASH_SOURCE[0]}" .sh)
+
+# Path to the test cases this suite should run. It is relative to the selenium/test folder
+TEST_CASES_PATH=/exchanges
+# Path to the folder where all configuration file reside. It is relative to the selenim/test folder
+TEST_CONFIG_PATH=/basic-auth
+
+source $SCRIPT/suite_template
+
+_setup () {
+  start_rabbitmq
+}
+_save_logs() {
+  save_container_logs rabbitmq
+}
+_teardown() {
+  kill_container_if_exist rabbitmq
+}
+run

deps/rabbitmq_management/selenium/suites/mgt-only-exchanges.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+SCRIPT="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+# Name of the suite used to generate log and screen folders
+SUITE=$( basename "${BASH_SOURCE[0]}" .sh)
+
+# Path to the test cases this suite should run. It is relative to the selenium/test folder
+TEST_CASES_PATH=/exchanges
+# Path to the folder where all configuration file reside. It is relative to the selenim/test folder
+TEST_CONFIG_PATH=/mgt-only
+
+source $SCRIPT/suite_template
+
+_setup () {
+  start_rabbitmq
+}
+_save_logs() {
+  save_container_logs rabbitmq
+}
+_teardown() {
+  kill_container_if_exist rabbitmq
+}
+run

deps/rabbitmq_management/selenium/test/basic-auth/happy-login.js

@@ -20,7 +20,7 @@ describe('An internal user with administrator tag', function () {
   })
 
   it('can log in into the management ui', async function () {
-    await login.login('guest', 'guest')    
+    await login.login('guest', 'guest')
     await overview.isLoaded()
     assert.equal(await overview.getUser(), 'User guest')
   })

deps/rabbitmq_management/selenium/test/exchanges/Makefile

@@ -0,0 +1,20 @@
+.ONESHELL:# single shell invocation for all lines in the recipe
+SHELL = bash# we depend on bash expansion for e.g. queue patterns
+
+.DEFAULT_GOAL = help
+RABBITMQ_SERVER_ROOT = ../../../../../
+RABBITMQ_CONFIG_FILE ?= basic-auth/rabbitmq.config
+
+### TARGETS ###
+
+help:
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+start-rabbitmq: ## Start RabbitMQ
+	@(docker kill rabbitmq >/dev/null 2>&1  && docker rm rabbitmq)
+	@(gmake --directory=${RABBITMQ_SERVER_ROOT} run-broker \
+		RABBITMQ_ENABLED_PLUGINS="rabbitmq_management" \
+		RABBITMQ_CONFIG_FILE=deps/rabbitmq_management/selenium/test/${RABBITMQ_CONFIG_FILE})
+
+test: ## Run tests interactively e.g. make test [TEST=landing.js]
+	@(RABBITMQ_URL=http://localhost:15672 RUN_LOCAL=true SCREENSHOTS_DIR=${PWD}/../../screens npm test $(PWD)/$(TEST))

deps/rabbitmq_management/selenium/test/exchanges/management.js

@@ -0,0 +1,61 @@
+const { By, Key, until, Builder } = require('selenium-webdriver')
+require('chromedriver')
+const assert = require('assert')
+const { buildDriver, goToHome, captureScreensFor, teardown, delay } = require('../utils')
+
+const LoginPage = require('../pageobjects/LoginPage')
+const OverviewPage = require('../pageobjects/OverviewPage')
+const ExchangesPage = require('../pageobjects/ExchangesPage')
+const ExchangePage = require('../pageobjects/ExchangePage')
+
+describe('Exchange management', function () {
+  let login
+  let exchanges
+  let exchange
+  let overview
+  let captureScreen
+
+  before(async function () {
+    driver = buildDriver()
+    await goToHome(driver)
+    login = new LoginPage(driver)
+    overview = new OverviewPage(driver)
+    exchanges = new ExchangesPage(driver)
+    exchange = new ExchangePage(driver)
+    captureScreen = captureScreensFor(driver, __filename)
+
+    await login.login('guest', 'guest')
+    if (!await overview.isLoaded()) {
+      throw new Error('Failed to login')
+    }
+    overview.clickOnExchangesTab()
+  })
+
+  it('display summary of exchanges', async function () {
+    assert.equal("All exchanges (7)", await exchanges.getPagingSectionHeaderText())
+  })
+
+  it('list all default exchanges', async function () {
+    actual_table = await exchanges.getExchangesTable(3)
+    expected_table = [
+      ["(AMQP default)", "direct", "D"],
+      ["amq.direct", "direct", "D"],
+      ["amq.fanout", "fanout", "D"],
+      ["amq.headers", "headers", "D"],
+      ["amq.match", "headers", "D"],
+      ["amq.rabbitmq.trace", "topic",	"D I"],
+      ["amq.topic", "topic", "D"]
+    ]
+    assert.deepEqual(actual_table, expected_table)
+  })
+
+  it('view one exchange', async function () {
+    await exchanges.clickOnExchange("%2F", "amq.fanout")
+    await exchange.isLoaded()
+    assert.equal("amq.fanout", await exchange.getName())
+  })
+
+  after(async function () {
+    await teardown(driver, this, captureScreen)
+  })
+})

deps/rabbitmq_management/selenium/test/mgt-only/enabled_plugins

@@ -0,0 +1 @@
+[rabbitmq_management].

deps/rabbitmq_management/selenium/test/mgt-only/rabbitmq.config

@@ -0,0 +1,12 @@
+[
+  {rabbit, [
+    {auth_backends, [rabbit_auth_backend_internal]}
+  ]},
+   {rabbitmq_management, [
+      {login_session_timeout, 150}   %% in minutes
+  ]},
+  {rabbitmq_management_agent, [
+     {disable_metrics_collector, true}
+  ]}
+
+].

deps/rabbitmq_management/selenium/test/pageobjects/BasePage.js

@@ -1,5 +1,15 @@
 const { By, Key, until, Builder } = require('selenium-webdriver')
 
+const MENU_TABS = By.css('div#menu ul#tabs')
+const USER = By.css('li#logout')
+const LOGOUT_FORM = By.css('li#logout form')
+
+const CONNECTION_TAB = By.css('div#menu ul#tabs li a[href="#/connections"]')
+const CHANNELS_TAB = By.css('div#menu ul#tabs li a[href="#/channels"]')
+const QUEUES_TAB = By.css('div#menu ul#tabs li a[href="#/queues"]')
+const EXCHANGES_TAB = By.css('div#menu ul#tabs li a[href="#/exchanges"]')
+const ADMIN_TAB = By.css('div#menu ul#tabs li a[href="#/users"]')
+
 module.exports = class BasePage {
   driver
   timeout
@@ -12,6 +22,53 @@ module.exports = class BasePage {
     this.polling = parseInt(process.env.POLLING) || 1000 // how frequent selenium searches for an element
   }
 
+  async isLoaded () {
+    return this.waitForDisplayed(MENU_TABS)
+  }
+
+  async logout () {
+    await this.submit(LOGOUT_FORM)
+  }
+
+  async getUser () {
+    return this.getText(USER)
+  }
+
+  async clickOnConnectionsTab () {
+    return this.click(CONNECTION_TAB)
+  }
+
+  async clickOnAdminTab () {
+    return this.click(ADMIN_TAB)
+  }
+
+  async clickOnChannelsTab () {
+    return this.click(CHANNELS_TAB)
+  }
+
+  async clickOnExchangesTab () {
+    return this.click(EXCHANGES_TAB)
+  }
+
+  async clickOnQueuesTab () {
+    return this.click(QUEUES_TAB)
+  }
+
+  async getTable(locator, firstNColumns) {
+    let table = await this.waitForDisplayed(locator)
+    let rows = await table.findElements(By.css('tbody tr'))
+    let table_model = []
+    for (let row of rows) {
+      let columns = await row.findElements(By.css('td'))
+      let table_row = []
+      for (let column of columns) {
+        if (table_row.length < firstNColumns) table_row.push(await column.getText())
+      }
+      table_model.push(table_row)
+    }
+    return table_model
+  }
+
   async waitForLocated (locator) {
     return this.driver.wait(until.elementLocated(locator), this.timeout, 'Timed out after 30 seconds', this.polling);
   }

deps/rabbitmq_management/selenium/test/pageobjects/ExchangePage.js

@@ -0,0 +1,16 @@
+const { By, Key, until, Builder } = require('selenium-webdriver')
+
+const BasePage = require('./BasePage')
+
+
+const EXCHANGE_NAME = By.css('div#main h1 b')
+
+
+module.exports = class ExchangePage extends BasePage {
+  async isLoaded() {
+    return this.waitForDisplayed(EXCHANGE_NAME)
+  }
+  async getName() {
+    return this.getText(EXCHANGE_NAME)
+  }
+}

deps/rabbitmq_management/selenium/test/pageobjects/ExchangesPage.js

@@ -0,0 +1,25 @@
+const { By, Key, until, Builder } = require('selenium-webdriver')
+
+const BasePage = require('./BasePage')
+
+
+const PAGING_SECTION = By.css('div#exchanges-paging-section')
+const PAGING_SECTION_HEADER = By.css('div#exchanges-paging-section h2')
+
+const TABLE_SECTION = By.css('div#exchanges-table-section table')
+
+module.exports = class ExchangesPage extends BasePage {
+  async isLoaded () {
+    return this.waitForDisplayed(PAGING_SECTION)
+  }
+  async getPagingSectionHeaderText() {
+    return this.getText(PAGING_SECTION_HEADER)
+  }
+  async getExchangesTable(firstNColumns) {
+    return this.getTable(TABLE_SECTION, firstNColumns)
+  }
+  async clickOnExchange(vhost, name) {
+    return this.click(By.css(
+      "div#exchanges-table-section table tbody tr td a[href='#/exchanges/" + vhost + "/" + name + "']"))
+  }
+}

deps/rabbitmq_management/selenium/test/pageobjects/OverviewPage.js

@@ -2,14 +2,6 @@ const { By, Key, until, Builder } = require('selenium-webdriver')
 
 const BasePage = require('./BasePage')
 
-const MENU_TABS = By.css('div#menu ul#tabs')
-const USER = By.css('li#logout')
-const LOGOUT_FORM = By.css('li#logout form')
-
-const CONNECTION_TAB = By.css('div#menu ul#tabs li a[href="#/connections"]')
-const CHANNELS_TAB = By.css('div#menu ul#tabs li a[href="#/channels"]')
-const QUEUES_TAB = By.css('div#menu ul#tabs li a[href="#/queues"]')
-const ADMIN_TAB = By.css('div#menu ul#tabs li a[href="#/users"]')
 
 const UPLOAD_DEFINITIONS_SECTION = By.css('div#upload-definitions-section')
 const CHOOSE_BROKER_UPLOAD_FILE = By.css('input[name="file"]')
@@ -21,33 +13,6 @@ const CHOOSE_BROKER_DOWNLOAD_FILE = By.css('input#download-filename')
 const DOWNLOAD_BROKER_FILE = By.css('button#upload-definitions')
 
 module.exports = class OverviewPage extends BasePage {
-  async isLoaded () {
-    return this.waitForDisplayed(MENU_TABS)
-  }
-
-  async logout () {
-    await this.submit(LOGOUT_FORM)
-  }
-
-  async getUser () {
-    return this.getText(USER)
-  }
-
-  async clickOnConnectionsTab () {
-    return this.click(CONNECTION_TAB)
-  }
-
-  async clickOnAdminTab () {
-    return this.click(ADMIN_TAB)
-  }
-
-  async clickOnChannelsTab () {
-    return this.click(CHANNELS_TAB)
-  }
-
-  async clickOnQueuesTab () {
-    return this.click(QUEUES_TAB)
-  }
 
   async uploadBrokerDefinitions(file) {
     await this.click(UPLOAD_DEFINITIONS_SECTION)

deps/rabbitmq_management/selenium/test/utils.js

@@ -92,4 +92,5 @@ module.exports = {
     }
     await driver.quit()
   }
+
 }

deps/rabbitmq_management/src/rabbit_mgmt_wm_exchange.erl

@@ -41,9 +41,15 @@ resource_exists(ReqData, Context) ->
 
 to_json(ReqData, Context) ->
     try
-        [X] = rabbit_mgmt_db:augment_exchanges(
+      case rabbit_mgmt_util:disable_stats(ReqData) of
+        false ->
+          [X] = rabbit_mgmt_db:augment_exchanges(
                 [exchange(ReqData)], rabbit_mgmt_util:range(ReqData), full),
-        rabbit_mgmt_util:reply(rabbit_mgmt_format:strip_pids(X), ReqData, Context)
+          rabbit_mgmt_util:reply(rabbit_mgmt_format:strip_pids(X), ReqData, Context);
+        true ->
+          rabbit_mgmt_util:reply(rabbit_mgmt_format:strip_pids(exchange(ReqData)),
+                ReqData, Context)
+      end
     catch
         {error, invalid_range_parameters, Reason} ->
             rabbit_mgmt_util:bad_request(iolist_to_binary(Reason), ReqData, Context)