import { each } from 'lodash'; import { ScopedVars, TimeZone } from '@grafana/data'; import { getTheme } from '@grafana/ui'; import TableModel from 'app/core/TableModel'; import { TableRenderer } from '../renderer'; import { ColumnRender } from '../types'; const utc: TimeZone = 'utc'; const sanitize = (): string => { return 'sanitized'; }; const templateSrv = { replace: (value: string, scopedVars: ScopedVars) => { if (scopedVars) { // For testing variables replacement in link each(scopedVars, (val, key) => { value = value.replace('$' + key, val?.value); }); } return value; }, }; describe('when rendering table', () => { describe('given 13 columns', () => { const table = new TableModel(); table.columns = [ { text: 'Time' }, { text: 'Value' }, { text: 'Colored' }, { text: 'Undefined' }, { text: 'String' }, { text: 'United', unit: 'bps' }, { text: 'Sanitized' }, { text: 'Link' }, { text: 'Array' }, { text: 'Mapping' }, { text: 'RangeMapping' }, { text: 'MappingColored' }, { text: 'RangeMappingColored' }, { text: 'HiddenType' }, { text: 'RightAligned' }, ]; table.rows = [ [ 1388556366666, 1230, 40, undefined, '', '', 'my.host.com', 'host1', ['value1', 'value2'], 1, 2, 1, 2, 'ignored', 42, ], ]; const panel = { pageSize: 10, styles: [ { pattern: 'Time', type: 'date', format: 'LLL', alias: 'Timestamp', }, { pattern: '/(Val)ue/', type: 'number', unit: 'ms', decimals: 3, alias: '$1', }, { pattern: 'Colored', type: 'number', unit: 'none', decimals: 1, colorMode: 'value', thresholds: [50, 80], colors: ['#00ff00', 'semi-dark-orange', 'rgb(1,0,0)'], }, { pattern: 'String', type: 'string', }, { pattern: 'String', type: 'string', }, { pattern: 'United', type: 'number', unit: 'ms', decimals: 2, }, { pattern: 'Sanitized', type: 'string', sanitize: true, }, { pattern: 'Link', type: 'string', link: true, linkUrl: '/dashboard?param=$__cell¶m_1=$__cell_1¶m_2=$__cell_2', linkTooltip: '$__cell $__cell_1 $__cell_6', linkTargetBlank: true, }, { pattern: 'Array', type: 'number', unit: 'ms', decimals: 3, }, { pattern: 'Mapping', type: 'string', mappingType: 1, valueMaps: [ { value: '1', text: 'on', }, { value: '0', text: 'off', }, { value: 'HELLO WORLD', text: 'HELLO GRAFANA', }, { value: 'value1, value2', text: 'value3, value4', }, ], }, { pattern: 'RangeMapping', type: 'string', mappingType: 2, rangeMaps: [ { from: '1', to: '3', text: 'on', }, { from: '3', to: '6', text: 'off', }, ], }, { pattern: 'MappingColored', type: 'string', mappingType: 1, valueMaps: [ { value: '1', text: 'on', }, { value: '0', text: 'off', }, ], colorMode: 'value', thresholds: [1, 2], colors: ['#00ff00', 'semi-dark-orange', 'rgb(1,0,0)'], }, { pattern: 'RangeMappingColored', type: 'string', mappingType: 2, rangeMaps: [ { from: '1', to: '3', text: 'on', }, { from: '3', to: '6', text: 'off', }, ], colorMode: 'value', thresholds: [2, 5], colors: ['#00ff00', 'semi-dark-orange', 'rgb(1,0,0)'], }, { pattern: 'HiddenType', type: 'hidden', }, { pattern: 'RightAligned', align: 'right', }, ], }; //@ts-ignore const renderer = new TableRenderer(panel, table, utc, sanitize, templateSrv, getTheme()); it('time column should be formatted', () => { const html = renderer.renderCell(0, 0, 1388556366666); expect(html).toBe('2014-01-01T06:06:06Z'); }); it('time column with epoch as string should be formatted', () => { const html = renderer.renderCell(0, 0, '1388556366666'); expect(html).toBe('2014-01-01T06:06:06Z'); }); it('time column with RFC2822 date as string should be formatted', () => { const html = renderer.renderCell(0, 0, 'Sat, 01 Dec 2018 01:00:00 GMT'); expect(html).toBe('2018-12-01T01:00:00Z'); }); it('time column with ISO date as string should be formatted', () => { const html = renderer.renderCell(0, 0, '2018-12-01T01:00:00Z'); expect(html).toBe('2018-12-01T01:00:00Z'); }); it('undefined time column should be rendered as -', () => { const html = renderer.renderCell(0, 0, undefined); expect(html).toBe('-'); }); it('null time column should be rendered as -', () => { const html = renderer.renderCell(0, 0, null); expect(html).toBe('-'); }); it('number column with unit specified should ignore style unit', () => { const html = renderer.renderCell(5, 0, 1230); expect(html).toBe('1.23 kb/s'); }); it('number column should be formatted', () => { const html = renderer.renderCell(1, 0, 1230); expect(html).toBe('1.230 s'); }); it('number column should format numeric string values', () => { const html = renderer.renderCell(1, 0, '1230'); expect(html).toBe('1.230 s'); }); it('number style should ignore string non-numeric values', () => { const html = renderer.renderCell(1, 0, 'asd'); expect(html).toBe('asd'); }); it('colored cell should have style (handles HEX color values)', () => { const html = renderer.renderCell(2, 0, 40); expect(html).toBe('40.0'); }); it('colored cell should have style (handles named color values', () => { const html = renderer.renderCell(2, 0, 55); expect(html).toBe(`55.0`); }); it('colored cell should have style handles(rgb color values)', () => { const html = renderer.renderCell(2, 0, 85); expect(html).toBe('85.0'); }); it('unformated undefined should be rendered as string', () => { const html = renderer.renderCell(3, 0, 'value'); expect(html).toBe('value'); }); it('string style with escape html should return escaped html', () => { const html = renderer.renderCell(4, 0, '&breaking
the
row'); expect(html).toBe('&breaking <br /> the <br /> row'); }); it('undefined formater should return escaped html', () => { const html = renderer.renderCell(3, 0, '&breaking
the
row'); expect(html).toBe('&breaking <br /> the <br /> row'); }); it('undefined value should render as -', () => { const html = renderer.renderCell(3, 0, undefined); expect(html).toBe(''); }); it('sanitized value should render as', () => { const html = renderer.renderCell(6, 0, 'text link'); expect(html).toBe('sanitized'); }); it('Time column title should be Timestamp', () => { expect(table.columns[0].title).toBe('Timestamp'); }); it('Value column title should be Val', () => { expect(table.columns[1].title).toBe('Val'); }); it('Colored column title should be Colored', () => { expect(table.columns[2].title).toBe('Colored'); }); it('link should render as', () => { const html = renderer.renderCell(7, 0, 'host1'); const expectedHtml = ` host1 `; expect(normalize(html)).toBe(normalize(expectedHtml)); }); it('Array column should not use number as formatter', () => { const html = renderer.renderCell(8, 0, ['value1', 'value2']); expect(html).toBe('value1, value2'); }); it('numeric value should be mapped to text', () => { const html = renderer.renderCell(9, 0, 1); expect(html).toBe('on'); }); it('string numeric value should be mapped to text', () => { const html = renderer.renderCell(9, 0, '0'); expect(html).toBe('off'); }); it('string value should be mapped to text', () => { const html = renderer.renderCell(9, 0, 'HELLO WORLD'); expect(html).toBe('HELLO GRAFANA'); }); it('array column value should be mapped to text', () => { const html = renderer.renderCell(9, 0, ['value1', 'value2']); expect(html).toBe('value3, value4'); }); it('value should be mapped to text (range)', () => { const html = renderer.renderCell(10, 0, 2); expect(html).toBe('on'); }); it('value should be mapped to text (range)', () => { const html = renderer.renderCell(10, 0, 5); expect(html).toBe('off'); }); it('array column value should not be mapped to text', () => { const html = renderer.renderCell(10, 0, ['value1', 'value2']); expect(html).toBe('value1, value2'); }); it('value should be mapped to text and colored cell should have style', () => { const html = renderer.renderCell(11, 0, 1); expect(html).toBe(`on`); }); it('value should be mapped to text and colored cell should have style', () => { const html = renderer.renderCell(11, 0, '1'); expect(html).toBe(`on`); }); it('value should be mapped to text and colored cell should have style', () => { const html = renderer.renderCell(11, 0, 0); expect(html).toBe('off'); }); it('value should be mapped to text and colored cell should have style', () => { const html = renderer.renderCell(11, 0, '0'); expect(html).toBe('off'); }); it('value should be mapped to text and colored cell should have style', () => { const html = renderer.renderCell(11, 0, '2.1'); expect(html).toBe('2.1'); }); it('value should be mapped to text (range) and colored cell should have style', () => { const html = renderer.renderCell(12, 0, 0); expect(html).toBe('0'); }); it('value should be mapped to text (range) and colored cell should have style', () => { const html = renderer.renderCell(12, 0, 1); expect(html).toBe('on'); }); it('value should be mapped to text (range) and colored cell should have style', () => { const html = renderer.renderCell(12, 0, 4); expect(html).toBe(`off`); }); it('value should be mapped to text (range) and colored cell should have style', () => { const html = renderer.renderCell(12, 0, '7.1'); expect(html).toBe('7.1'); }); it('hidden columns should not be rendered', () => { const html = renderer.renderCell(13, 0, 'ignored'); expect(html).toBe(''); }); it('right aligned column should have correct text-align style', () => { const html = renderer.renderCell(14, 0, 42); expect(html).toBe('42'); }); it('render_values should ignore hidden columns', () => { renderer.render(0); // this computes the hidden markers on the columns const { columns, rows } = renderer.render_values(); expect(rows).toHaveLength(1); expect(columns).toHaveLength(table.columns.length - 1); expect(columns.filter((col: ColumnRender) => col.hidden)).toHaveLength(0); }); }); }); describe('when rendering table with different patterns', () => { it.each` column | pattern | expected ${'Requests (Failed)'} | ${'/Requests \\(Failed\\)/'} | ${'1.230 s'} ${'Requests (Failed)'} | ${'/(Req)uests \\(Failed\\)/'} | ${'1.230 s'} ${'Requests (Failed)'} | ${'Requests (Failed)'} | ${'1.230 s'} ${'Requests (Failed)'} | ${'Requests \\(Failed\\)'} | ${'1.230 s'} ${'Requests (Failed)'} | ${'/.*/'} | ${'1.230 s'} ${'Some other column'} | ${'/.*/'} | ${'1.230 s'} ${'Requests (Failed)'} | ${'/Requests (Failed)/'} | ${'1230'} ${'Requests (Failed)'} | ${'Response (Failed)'} | ${'1230'} `( 'number column should be formatted for a column:$column with the pattern:$pattern', ({ column, pattern, expected }) => { const table = new TableModel(); table.columns = [{ text: 'Time' }, { text: column }]; table.rows = [[1388556366666, 1230]]; const panel = { pageSize: 10, styles: [ { pattern: 'Time', type: 'date', format: 'LLL', alias: 'Timestamp', }, { pattern: pattern, type: 'number', unit: 'ms', decimals: 3, alias: pattern, }, ], }; //@ts-ignore const renderer = new TableRenderer(panel, table, utc, sanitize, templateSrv, getTheme()); const html = renderer.renderCell(1, 0, 1230); expect(html).toBe(expected); } ); }); describe('when rendering cells with different alignment options', () => { const cases: Array<[string, boolean, string | null, string]> = [ //align, preserve fmt, color mode, expected ['', false, null, '42'], ['invalid_option', false, null, '42'], ['alert("no xss");', false, null, '42'], ['auto', false, null, '42'], ['justify', false, null, '42'], ['auto', true, null, '42'], ['left', false, null, '42'], ['left', true, null, '42'], ['center', false, null, '42'], [ 'center', true, 'cell', '42', ], [ 'right', false, 'cell', '42', ], [ 'right', true, 'cell', '42', ], ]; it.each(cases)( 'align option:"%s", preformatted:%s columns should be formatted with correct style', (align: string, preserveFormat: boolean, colorMode, expected: string) => { const table = new TableModel(); table.columns = [{ text: 'Time' }, { text: align }]; table.rows = [[0, 42]]; const panel = { pageSize: 10, styles: [ { pattern: 'Time', type: 'date', format: 'LLL', alias: 'Timestamp', }, { pattern: `/${align}/`, align: align, type: 'number', unit: 'none', preserveFormat: preserveFormat, colorMode: colorMode, thresholds: [1, 2], colors: ['rgba(245, 54, 54, 0.9)', 'rgba(237, 129, 40, 0.89)', 'rgba(50, 172, 45, 0.97)'], }, ], }; //@ts-ignore const renderer = new TableRenderer(panel, table, utc, sanitize, templateSrv, getTheme()); const html = renderer.renderCell(1, 0, 42); expect(html).toBe(expected); } ); }); function normalize(str: string) { return str.replace(/\s+/gm, ' ').trim(); }