Source: e2e/fields/CheckboxesField.js

  1. 'use strict';
  3. /**
  4.  * @module e2e/fields/CheckboxesField
  5.  */
  7. var util = require('util');
  8. var Field = process.requireTest('lib/e2e/fields/Field.js');
  9. var browserExt = process.requireTest('lib/e2e/browser.js');
  11. /**
  12.  * Defines a form checkboxes field.
  13.  *
  14.  * Use [Field.get]{@link module:e2e/fields/Field~Field.get} method to get an instance of CheckboxesField.
  15.  *
  16.  * @example
  17.  * var Field = require('@openveo/test').e2e.fields.Field;
  18.  *
  19.  * var CheckboxesField = Field.get({
  20.  *   type: 'checkboxes',
  21.  *   name: 'My field',
  22.  *   baseElement: element(by.css('form'))
  23.  * });
  24.  *
  25.  * @class CheckboxesField
  26.  * @extends module:e2e/fields/Field~Field
  27.  * @constructor
  28.  * @param {Object} conf A field configuration object
  29.  */
  30. function CheckboxesField(conf) {
  31.   CheckboxesField.super_.call(this, conf);
  32. }
  34. module.exports = CheckboxesField;
  35. util.inherits(CheckboxesField, Field);
  37. /**
  38.  * Gets selected checkboxe names.
  39.  *
  40.  * @example
  41.  * myField.getValue().then(function(values) {
  42.  *   console.log(values);
  43.  * });
  44.  *
  45.  * @return {Promise} Promise resolving with selected checkboxes
  46.  */
  47. CheckboxesField.prototype.getValue = function() {
  48.   var values = [];
  50.   return this.getElement().then(function(elementFinder) {
  52.     // Iterate on each checkbox labels
  53.     elementFinder.all(by.css('.checkbox label')).each(function(label, index) {
  55.       // Test if checkbox is checked
  56.       browserExt.getProperty(label.element(by.css('input')), 'checked').then(function(isChecked) {
  58.         // Get checkbox name
  59.         label.getText().then(function(text) {
  60.           if (isChecked)
  61.             values.push(text.replace(/ ?\*?$/, ''));
  62.         });
  64.       });
  66.     });
  68.   }).then(function() {
  69.     return protractor.promise.fulfilled(values);
  70.   });
  71. };
  73. /**
  74.  * Sets field value.
  75.  *
  76.  * @example
  77.  * myField.setValue(['Label 1', 'Label 2']).then(function() {
  78.  *   console.log('Value set');
  79.  * });
  80.  *
  81.  * @param {Array} [values=[]] Checkboxe's values
  82.  * @return {Promise} Promise resolving when checkboxes are checked
  83.  */
  84. CheckboxesField.prototype.setValue = function(values) {
  85.   values = values || [];
  87.   return this.getElement().then(function(elementFinder) {
  89.     // Iterate on each checkbox labels
  90.     elementFinder.all(by.css('.checkbox label')).each(function(label, index) {
  92.       // Test if checkbox is checked
  93.       browserExt.getProperty(label.element(by.css('input')), 'checked').then(function(isChecked) {
  95.         // Get checkbox name
  96.         label.getText().then(function(text) {
  97.           var isPartOfValues = values.indexOf(text.replace(/ ?\*?$/, '')) >= 0;
  99.           if ((!isChecked && isPartOfValues) || (isChecked && !isPartOfValues)) {
  101.             // Checkbox not checked and must be or checked and must not
  102.             browserExt.click(label);
  104.           }
  105.         });
  107.       });
  109.     });
  111.   }).then(function() {
  112.     return protractor.promise.fulfilled();
  113.   });
  114. };
  116. /**
  117.  * Unchecks all checkboxes.
  118.  *
  119.  * @example
  120.  * myField.clear().then(function() {
  121.  *   console.log('Field cleared');
  122.  * });
  123.  *
  124.  * @return {Promise} Promise resolving when the field is cleared
  125.  */
  126. CheckboxesField.prototype.clear = function() {
  127.   return this.setValue();
  128. };
  130. /**
  131.  * Gets all checkboxes labels.
  132.  *
  133.  * @example
  134.  * myField.getOptions().then(function(options) {
  135.  *   console.log(options);
  136.  * });
  137.  *
  138.  * @return {Promise} Promise resolving with checkboxes options
  139.  */
  140. CheckboxesField.prototype.getOptions = function() {
  141.   var options = [];
  143.   return this.getElement().then(function(elementFinder) {
  145.     // Iterate on each checkbox labels
  146.     elementFinder.all(by.css('.checkbox label')).each(function(label, index) {
  148.       // Get checkbox name
  149.       label.getText().then(function(text) {
  150.         options.push(text.replace(/ ?\*?$/, ''));
  151.       });
  153.     });
  155.   }).then(function() {
  156.     return protractor.promise.fulfilled(options);
  157.   });
  158. };