microsoft / powerbi-visuals-utils-testutils Goto Github PK

View Code? Open in Web Editor NEW

16.0 15.0 28.0 868 KB

Test utility interfaces for testing powerbi custom visuals

License: Other

JavaScript 0.71% TypeScript 99.29%

powerbi-visuals-utils-testutils's Introduction

Microsoft Power BI visuals TestUtils

TestUtils is a set of mocks and fakes in order to simplify unit testing for Power BI custom visuals

Usage

Usage Guide

2.3.0 Migration note

From version 2.3.0 testDom function returns HTMLElement instead of JQuery object. If you are using JQuery in tests, wrap the testDom calls with $(...) for compatibility:

    // 2.2.1 and below
    let element: JQuery = testDom("100", "100");
    // 2.3.0 and above
    let element: JQuery = $(testDom("100", "100"));

The motivation is not to force JQuery usage. It might be not necessary in tests. In lots of cases element.get(0) is the next operation after receiving an element with testDom. Now JQuery is not required to use powerbi-visuals-utils-testutils, so you can drop this dependency. If you keep it, you can easily migrate your code to 2.3.* version using the example above.

Contributing

Read our contribution guideline to find out how to contribute bugs fixes and improvements
Issue Tracker
Development workflow
How to build
How to run unit tests locally

License

See the LICENSE file for license rights and limitations (MIT).

powerbi-visuals-utils-testutils's People

Contributors

Stargazers

Watchers

powerbi-visuals-utils-testutils's Issues

applyJsonFilter missing from MockIVisualHost

I believe that applyJsonFilter() method is missing from MockIVisualHost in release 1.0.2 (and before).

Missing IColorPalette isHighContrast, foreground, background, ... properties

Since the mockIColorPalette.ts file contains the default implementation of isHighContrast, foreground, background, etc... properties of IColorPalette, the produced mockIColorPalette.js file on npm package don't.

I had to manually update the code by adding the following code inside export class MockIColorPalette { }:

isHighContrast = true;
foreground = {value: "#333333" };
foregroundLight = {value: "#FFF" };
foregroundDark = {value: "#000" };
foregroundNeutralLight = {value: "#EAEAEA" };
foregroundNeutralDark = {value: "#212121" };
foregroundNeutralSecondary = {value: "#666666" };
foregroundNeutralSecondaryAlt = {value: "#777777" };
foregroundNeutralSecondaryAlt2 = {value: "#888888" };
foregroundNeutralTertiary = {value: "#A6A6A6" };
foregroundNeutralTertiaryAlt = {value: "#C8C8C8" };
foregroundSelected = {value: "#333333" };
foregroundButton = {value: "#666666" };
background = {value: "#FFF" };
backgroundLight = {value: "#EAEAEA" };
backgroundNeutral = {value: "#C8C8C8" };
backgroundDark = {value: "#000" };
hyperlink = {value: "#1F3A93" };
visitedHyperlink = {value: "#551A8B" };
mapPushpin = {value: "#FF5F00" };
shapeStroke = {value: "#01B8AA" };
selection = {value: undefined };
separator = {value: undefined };
negative = {value: undefined };
neutral = {value: undefined };
positive = {value: undefined };

Can you please recompile the source files and update the package?

Thanks!

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

Does not work with API 1.7

Got lot's of errors in testUtils due to dependency issue
@ignatvilesov

typings install issue

i ran the following command and got a warning or error. I wanted to see if this was correct or if i need to update.
`...>typings install --save --global dt~~d3#0.0.0+20160907005744 dt~~jasmine#2.5.0+20161025102649 dt~~jasmine-jquery#0.0.0+20160317120654 dt~~jquery#1.10.0+2016092916
2922 dt~lodash#4.14.0+20161028154038

typings WARN deprecated 5/9/2016: "registry:dt/jasmine-jquery#0.0.0+20160317120654" is deprecated (updated, replaced or removed)

typings WARN deprecated 11/10/2016: "registry:dt/lodash#4.14.0+20161028154038" is deprecated (updated, replaced or removed)

typings INFO reference Stripped reference "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/7de6c3dd94feaeb21f20054b9f30d5dabc5efabd/jasmine/jasmine.d.ts" during installation
from "jasmine-jquery" (main)

typings INFO reference Stripped reference "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/7de6c3dd94feaeb21f20054b9f30d5dabc5efabd/jquery/jquery.d.ts" during installation f
rom "jasmine-jquery" (main)

d3
`-- (No dependencies)

jasmine
`-- (No dependencies)

jasmine-jquery
`-- (No dependencies)

jquery
`-- (No dependencies)

lodash
-- (No dependencies)

TestUtils compatibility with newer custom visuals APIs (3.8 and later)

It looks like that latest version of testutils is not yet compatible with latest custom visuals APIs due to move of the visual host.allowInteractions property -> host.hostCapabilities.allowInteractions.

Any plans to update?