Skip to content

Commit f70fd32

Browse files
authored
Merge pull request #590 from microsoft/southworks/update/documentation-msi
[#548] Create Fn tests for supported authentication types - Update documentation
2 parents f061641 + 3b7889f commit f70fd32

File tree

5 files changed

+37
-23
lines changed

5 files changed

+37
-23
lines changed

Docs/availableBotsList.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,13 @@ These are the bots currently available. This list will be expanded in the future
77
- BffnSimpleComposerHostBotDotNet
88
- BffnSimpleHostBotDotNet
99
- BffnWaterfallHostBotDotNet
10+
- BffnComposerHostBotDotNet
1011
- Skills
1112
- BffnEchoComposerSkillBotDotNet
1213
- BffnEchoSkillBotDotNet
1314
- BffnEchoSkillBotDotNetV3
1415
- BffnWaterfallSkillBotDotNet
16+
- BffnComposerSkillBotDotNet
1517

1618
- JS
1719
- Consumers

Docs/media/Diagrams.pptx

650 Bytes
Binary file not shown.

Docs/media/branching.png

15.2 KB
Loading

Docs/pipelines.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ This repo contains a script to create badges of App Registrations to ease pipeli
6363
The following parameters will be displayed in the run pipeline blade.
6464

6565
The version parameters can be set here or you can create variables to set the values for the next pipeline's runs.
66-
Supported values are: LATEST (default), STABLE, or a specific version.
66+
Supported values are: LATEST (default for Artifacts and MyGet), STABLE (default for NuGet, npm and PyPI), or a specific version.
6767
For example:
68-
DEPENDENCIESVERSIONDOTNETHOSTS = 4.13.1
68+
DEPENDENCIESVERSIONDOTNETHOSTS = 4.15.2
6969

7070
![dependenciesParameters](./media/dependenciesParameters.png)
7171

@@ -89,31 +89,31 @@ These are the available registry options for each bot language:
8989
- Npm
9090
- Python (Not available for SkillsV3)
9191
- Artifacts (default)
92-
- Pypi
93-
- Test.Pypi
92+
- PyPI
93+
- Test.PyPI
9494

9595
Supported Version inputs are:
9696

9797
| Name | Description | Example |
9898
| -------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------- |
99-
| **LATEST** | (default) The latest published version available in the chosen registry, it will search for `stable` or `preview` versions. | LATEST |
100-
| **STABLE** | The latest stable published version available in the chosen registry, it will only search for `stable` versions. | STABLE |
101-
| **Specific Version** | Version format based on how it's published in the chosen registry. | 4.13.0 |
99+
| **LATEST** | (default for Artifacts and MyGet) The latest published version available in the chosen registry, it will search for `stable` or `preview` versions. | LATEST |
100+
| **STABLE** | (default for NuGet, npm, and PyPI) The latest stable published version available in the chosen registry, it only will search for `stable` versions. | STABLE |
101+
| **Specific Version** | Version format based on how it's published in the chosen registry. | 4.15.2 |
102102

103103
## 03 - Run Test Scenarios Pipeline
104104

105105
- **YAML**: [build\yaml\testScenarios\runTestScenarios.yml](../build/yaml/testScenarios/runTestScenarios.yml)
106106

107-
| Variable Name | Source | Description | Default value | Example |
108-
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | ---------------------------------- |
109-
| **AzureSubscription** | Azure DevOps | Name of the Azure Resource Manager Service Connection configured in the DevOps organization. Click [here](./addARMServiceConnection.md) to see how to set it up. | | TestSubscription |
110-
| **AppServicePlanDotNetName** | User / Create Shared Resources | Name of the App Service Plan for DotNet bots. | - | appservicedotnet |
111-
| **AppServicePlanJSName** | User / Create Shared Resources | Name of the App Service Plan for JavaScript bots. | - | appservicejs |
112-
| **AppServicePlanPythonName** | User / Create Shared Resources | Name of the App Service Plan for Python bots. | - | appservicepython |
113-
| **ResourceGroup** | User | (optional) Name of the Resource Group where the bots are deployed. | | bots-group |
114-
| **ResourceSuffix** | Create Shared Resources | (optional) Suffix to add to the resources' name to avoid collitions (use lowercase, only letters and numbers). | | suffix |
115-
| **[BotName](./availableBotsList.md) + AppId** | [App Registration Portal](https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade) | (optional) Skill Bot App ID to use. If not configured, it will be retrieved from the key vault. | | x0x000x-000x-000x-xxx0-x00x0000xxx |
116-
| **SharedResourceGroup** | Create Shared Resources | (optional) Name of the Shared Resource Group where the shared resources are deployed. | **BFFN-Shared** | shared-resource-group |
107+
| Variable Name | Source | Description | Default value | Example |
108+
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | ---------------------------------- |
109+
| **AzureSubscription** | Azure DevOps | Name of the Azure Resource Manager Service Connection configured in the DevOps organization. Click [here](./addARMServiceConnection.md) to see how to set it up. | | TestSubscription |
110+
| **AppServicePlanDotNetName** | User / Create Shared Resources | Name of the App Service Plan for DotNet bots. | - | appservicedotnet |
111+
| **AppServicePlanJSName** | User / Create Shared Resources | Name of the App Service Plan for JavaScript bots. | - | appservicejs |
112+
| **AppServicePlanPythonName** | User / Create Shared Resources | Name of the App Service Plan for Python bots. | - | appservicepython |
113+
| **ResourceGroup** | User | (optional) Name of the Resource Group where the bots are deployed. | **BFFN** | bots-group |
114+
| **ResourceSuffix** | Create Shared Resources | (optional) Suffix to add to the resources' name to avoid collitions (use lowercase, only letters and numbers). | | suffix |
115+
| **SharedResourceGroup** | Create Shared Resources | (optional) Name of the Shared Resource Group. | **BFFN-Shared** | shared-resource-group |
116+
| **[BotName](./availableBotsList.md) + AppId** | [App Registration Portal](https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade) | (optional) Skill Bot App ID to use. If not configured, it will be retrieved from the key vault. | | x0x000x-000x-000x-xxx0-x00x0000xxx |
117117

118118
### Dependency Variables
119119

@@ -141,9 +141,9 @@ Supported Version inputs are:
141141

142142
| Name | Description | Example |
143143
| -------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------- |
144-
| **LATEST** | (default) The latest published version available in the chosen registry, it will search for `stable` or `preview` versions. | LATEST |
145-
| **STABLE** | The latest stable published version available in the chosen registry, it will only search for `stable` versions. | STABLE |
146-
| **Specific Version** | Version format based on how it's published in the chosen registry. | 4.13.0 |
144+
| **LATEST** | (default for Artifacts and MyGet) The latest published version available in the chosen registry, it will search for `stable` or `preview` versions. | LATEST |
145+
| **STABLE** | (default for NuGet, npm, and PyPI) The latest stable published version available in the chosen registry, it only will search for `stable` versions. | STABLE |
146+
| **Specific Version** | Version format based on how it's published in the chosen registry. | 4.15.2 |
147147

148148
## 04 - Cleanup Resources Pipeline
149149

Tests/Functional/README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
1-
# Skills Functional Tests
1+
# Functional Tests
22

33
## Summary
44

55
Skill functional testing aims to automate the testing of Host and Skill interactions through several scenarios in all available programming languages.
66

77
Head to [Docs](../../Docs/) directory for more information.
88

9-
### Branching
9+
## Available Test Cases
10+
### Skills
11+
The following scenarios are being tested with the different host-skill bots combinations:
12+
- Single Turn (simple echo with MultiTenant apps)
13+
- Waterfall Bots:
14+
- Cards
15+
- File Upload
16+
- Message with Attachments
17+
- Proactive Messages
18+
- Sign in
19+
- Authentication (SingleTenant and MSI app types)
20+
21+
## Branching
1022
In this repository, there are branches with pinned versions of the SDK to test patch releases.
11-
From R9 to R14, each branch contains the yamls and tests adapted to run the current implementation of the pipelines against older versions of the BotBuilder packages.
23+
From 4.9 to 4.15, each branch contains the yamls and tests adapted to run the current implementation of the pipelines against older versions of the BotBuilder packages.
1224

1325

1426
This image describes the bots included in the different branches.

0 commit comments

Comments
 (0)