@microsoft/teams-app-test-tool

Teams App Test Tool

Teams App Test Tool (or short as Test Tool) is a component integrated in Teams Toolkit. This component helps developers to debug, test and iterate on the app design of a Teams bot application in a web-based chat environment that emulates the behavior, look and feel of Microsoft Teams.

This package is a CLI wrapper for Teams App Test Tool component that aims for an easier integration between Teams Toolkit and Teams App Test Tool.

Features

Teams App Test Tool enables developers to:

• Sandbox Environment: Test and debug their bot application in a sandbox environment that emulates the behavior, look and feel of Microsoft Teams.

• Reduce Local Debugging Frictions: Remove the prerequisites to obtain a Microsoft 365 Developer tenant and side-loading permissions before debugging the Teams bot applications.

• Network Security: No need to set up a tunnel with Ngrok or Microsoft Dev Tunnel to expose the local bot application to the internet.

• Rapid Inner-Loop Iterations: Quickly iterate on the app design and bot logic without the need to re-deploy the bot application to the cloud.

• Mock Data and Activities: The test tool makes it easy to accomplish a test for complex scenarios such as Send a welcome message when a new member joins the channel by using mock data as well as built-in and custom activity triggers.

• Reliable and Trustable: You can trust the test tool because the Bot application UX (Adaptive Cards) is built on top of the same rendering technology as in Microsoft Teams.

• Integration with Existing Teams Bot Applications: The test tool can be integrated with existing Teams bot applications that are built with Bot Framework SDK.

• Easy Inspections: You can inspect the interactions between your bot application and the Test Tool as well as the request and response payloads coming in and out of your bot application.

Limitations

• Application manifest is not being processed in the Test Tool. This means features that enabled only through the manifest will not be available in the Test Tool. For example, The Bot Command Menu will not be available in the Test Tool.
• Not all types of Bot application UX (Cards) are supported in the Test Tool other than Adaptive Cards.
• Some features used in the Adaptive Card are not supported:
  • People picker
  • Dynamic type-ahead search
  • User mention
  • Image stage view
  • Full-width control
• Single Sign-On (SSO) is not supported in the Test Tool. This means the Bot SSO feature will not be available in the Test Tool.

FAQ

Q: What should I do when some features I use in my bot application but it's not supported in the Test Tool?

A: You can always use the Microsoft Teams client to test the features that are not supported in the Test Tool. If you are developing with Teams Toolkit, select the option Debug (Edge) or Debug (Chrome) to test your application in the Microsoft Teams client.

Q: How would I notice if some features are not supported in the Test Tool?

A: The Test Tool will show a warning message in conversation and log panel when it detects some features are not supported.

Q: Should I solely rely on the test tool to test my bot application?

A: No. We always recommend developers to test their bot application in the Microsoft Teams client before moving the application to production environment.

Shaping our roadmap

Teams platform is evolving rapidly and we are working hard to bring more features to the Test Tool. We would love to prioritize our backlogs based on your feedback and suggestions so we could cover more extensibility surfaces and scenarios. Please feel free to:

• Request a new feature
• File an issue
• Send an email to [e-mail] to chat with the product team

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

Reporting Security Issues

Please do not report security vulnerabilities through public GitHub issues.

Instead, please report them to the Microsoft Security Response Center (MSRC) at https://msrc.microsoft.com/create-report.

If you prefer to submit without logging in, send email to [e-mail]. If possible, encrypt your message with our PGP key; please download it from the the Microsoft Security Response Center PGP Key page.

You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at microsoft.com/msrc.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.