Skip to content

Commit

Permalink
Update documentation for #151 and review TOM
Browse files Browse the repository at this point in the history
  • Loading branch information
Cédric L. Charlier committed Dec 14, 2015
1 parent 14d0c10 commit b3c6d43
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 18 deletions.
9 changes: 6 additions & 3 deletions _data/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@
- compare-tolerances-roundings
- compare-intervals

- title: connection strings
docs:
- connection-configuration
- connetion-providers
- connection-powerbi-desktop

- title: Additional tests for result-sets
docs:
- resultset-rows-count
Expand Down Expand Up @@ -74,11 +80,8 @@

- title: Configuration and settings
docs:
- config-connection-strings
- config-defaults-references
- config-settings-external-file
- config-roles-query
- config-database-providers
- config-profile-csv
- config-profile-failure-report
- config-dtd-processing
Expand Down
4 changes: 2 additions & 2 deletions _documentation/config-defaults-references.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: documentation
title: Defaults and references
prev_section: config-connection-strings
prev_section: setup-condition
next_section: config-settings-external-file
permalink: /docs/config-defaults-references/
---
Expand Down Expand Up @@ -114,7 +114,7 @@ The sample here under creates two references named *first-ref* and *second-ref*
In a reference you can configure values for

* connection-string (more info in [Manage connection strings])
* Report (Source and Path)
* Report (Source and Path)
* regex
* numeric-format
* currency-format
2 changes: 1 addition & 1 deletion _documentation/config-profile-csv.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: documentation
title: CSV profile
prev_section: config-database-provider
prev_section: config-settings-external-file
next_section: config-profile-failure-report
permalink: /docs/config-profile-csv/
---
Expand Down
2 changes: 1 addition & 1 deletion _documentation/config-settings-external-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: documentation
title: Settings in external file
prev_section: config-defaults-references
next_section: config-roles-query
next_section: config-profile-csv
permalink: /docs/config-settings-external-file/
---
You can define in the config file the xml attribute *settings* to express that the settings are defined in an external file and not in the test-suite. The value of this xml attribute *settings* matches with the name of the external file containing your xml fragment with the *settings* element of your test-suite.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
layout: documentation
title: Manage connection strings
prev_section: setup-condition
next_section: config-defaults-references
permalink: /docs/config-connection-strings/
title: Connection strings in config files
prev_section: compare-intervals
next_section: connection-providers
permalink: /docs/connection-configuration/
---
## Default connection string
When you’ve more than a few tests, it's boring to repeat the same connection string for each test. For this kind of situation, the more efficient way to manage the connection strings is to specify a default value in the *settings* of your test suite. To achieve this, create a xml element named *settings* at the top of your test suite definition and define once the connection string for all your system-under-tests.
Expand Down
23 changes: 23 additions & 0 deletions _documentation/connection-powerbi-desktop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
layout: documentation
title: Database providers
prev_section: connection-providers
next_section: connection-roles
permalink: /docs/connection-powerbi-desktop/
---
To test a Power BI Desktop solution, you'll need to provide a connection-string redirecting to your Power BI Desktop solution. This connection-string must respect the following format: ```PBIX = Name of my Power BI Desktop solution```. The name of your solution should be the filename without the extension ".pbix".

**Important note: In order to test this Power BI Desktop solution, the pbix file must be running during the execution of a test-suite.**

{% highlight xml %}
<testSuite name="The Query TestSuite" xmlns="http://NBi/TestSuite">
<settings>
<default apply-to="system-under-test">
<connectionString>PBIX = My Solution</connectionString>
</default>
</settings>
<test name="...">
...
</test>
</testSuite>
{% endhighlight %}
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
layout: documentation
title: Database providers
prev_section: config-roles-query
next_section: config-profile-csv
permalink: /docs/config-database-providers/
prev_section: connection-configuration
next_section: connection-powerbi-desktop
permalink: /docs/connection-providers/
---
When dealing with standard Microsoft data sources, NBi automatically creates the correct connections and commands objects to query these data sources. The choice performed by NBi to create an object or another is dependent of the connection string.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
layout: documentation
title: Apply roles to a query
prev_section: config-settings-external-file
next_section: config-database-provider
permalink: /docs/config-roles-query/
prev_section: connection-powerbi-desktop
next_section: resultset-rows-count
permalink: /docs/connnection-roles/
---
It's a common practice in Business Intelligence to restrict views and data according to the user connected. The views are linked to the *roles* defined in Analysis Services. When testing an environment, it's useful to play with the different *roles* for which different results are expected. Changing the role is a feature available for any query targeting an SSAS environment.

Expand Down
2 changes: 1 addition & 1 deletion _documentation/setup-condition.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: documentation
title: Conditions for execution
prev_section: setup-wait
next_section: config-connection-strings
next_section: config-settings-external-file
permalink: /docs/setup-condition/
---
In addition to the [setup and cleanup decorations](../setup-cleanup) a test can also be preceded by a list of *conditions*. If one the conditions is not validated, the test will be *ignored (and not failed)*. An appropriate message will be inserted into the ignore message to explain why the test has been ignored by the framework.
Expand Down

0 comments on commit b3c6d43

Please sign in to comment.