Microsoft 365 Community Microsoft Graph, 2 Mar 2023

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Improve your test strategy with Microsoft Graph Developer Proxy

Description

In this 19-minute developer-focused demo, Adam Wójcik delivers a review affirming capabilities of Proxy to test the untestable and to improve the quality of your desktop apps by simulating responses to any API (Graph, not Graph). Run through UI automated and manual test scenarios in this demo. Review available parameters including ability to mock. Test results presented along with tips to fix. Test client applications without additional web APIs. Feedback always welcome. Conversation.

This PnP Community demo is taken from the Microsoft 365 & Power Platform Development Community call recorded on March 2, 2023.

Demo Presenter
• Adam Wójcik (Hitachi Energy) | @Adam25858782

Community Call Conversation
• aka.ms/Mar2-Demo2

Supporting materials
• Tool Repo - Microsoft Graph Developer Proxy | https://github.com/microsoftgraph/msgraph-developer-proxy
• Article - Join us for Hack Together: Microsoft Graph and .NET | https://devblogs.microsoft.com/dotnet/hack-together-microsoft-graph-dotnet/
• Demo - Introduction to Microsoft Graph Developer Proxy | https://youtu.be/jsXliaZCGqg
• Demo - Test how your SPFx solutions respond to throttling with Graph Developer Proxy | https://youtu.be/ljsMwf36lOY

Learn more
• Microsoft 365 Unified Sample gallery - https://aka.ms/community/samples
• Microsoft 365 Platform Community in YouTube - https://aka.ms/community/videos
• Microsoft 365 Platform Community - http://aka.ms/community/home

A

A

About me, my name is Adam I'm, a father and a pretty standard developer I'm one of the CLI for Microsoft 365 maintainers. So if you need any guidance or help regarding CLI just pick me up, I'm a quite fresh MVP still don't know what to do with it, but I guess it will be awesome, I'm, a freelancer, but for quite a long time I've been working for touch energy I'm located in Poland, and you can catch me on LinkedIn and Twitter.

A

Okay, let's move on so today, I will be doing a showing kind of a use case for the Microsoft developer. Proxy I hope it's a tool. You already had a chance to try out, if not I hope with this demo. I will motivate you to do so.

A

So basically, this is a console application that helps you test the untestable and improve the quality of your apps by simulating responses to to any kind of API, not also not only Microsoft graph apis like the name could suggest it could be configured to simulate errors or any kind of response for or any kind of API. So, with this tool, we can of course simulate errors. We can, for example, mock a specific response. We would like to have for a specific request.

A

uh This tool helps us demonstrate behaviors that are really hard to produce, especially on our test environment, where everything is always working and they also along the way they still provides. You guidance that you can, of course, turn off. I bet, it's cool to have them and, for example, to suggest you to use additional query parameters to select only the data I was supposed to use or, for example, to switch to using an SDK instead of just using an HTTP client which uh what I will be doing today.

A

Okay- and what's really awesome, it will run on nus and it's fully extendable with plugins. It's not a part of my demo today, but maybe near future. Let's see so if there is a use case that is not covered by this tool, and it's a bit out of scope for this tool.

A

It doesn't matter it cannot help you, you can still extend it with a plugin for your specific needs, and, what's really really important, is that the tool is still in the community preview uh like stage so it's not released yet, but it means that it really needs your feedback and testing and and any kind of feedback. I guess is important, of course, reporting bugs, of course, ideas, but also positive feedback. Like you know, if I denied it's awesome, I will use it in the future thanks.

A

This will be really good for the team to have so please, please provide feedback for the soul, especially now before it's released, so it's really okay to introduce breaking changes from uh priorities to pre-release, as opposed to maybe when it's released. It wouldn't be so okay to introduce a breaking change like after two weeks. Even if your idea is really awesome, so I will be covering a scenario of improving the test, a Test's quality of my desktop application, and you may ask okay: that's the application boring right. Why not a web application?

A

That's because there's already a use case and a scenario how you can use an integrate the tool with a web application and there's a demo provided by Seb some time ago on one of the PMP Community rules, so I'll just leave a link here, so we can just look it up and also, probably since we are on the Microsoft 365 words, you are using the sharper framework extensibility, and will this tool help us with this uh as well? Yes, and one that also presented a demo not so long ago regarding this okay?

A

So what about I'm writing scripts like I? Do a lot so can this tool help me like test improve testing of my scripts Yes? Actually, it is as long as your script in CLI or PNP, partial or whatever is actually doing some request called proxy can intercept so and regarding the desktop apps. What the? What kind of desktop application do? I mean I mean any kind of Association, so uh I mean kind if you can think of so.

A

The the main idea, I I'm, trying to the show present here- is that a gift here that actually that Microsoft graph developer proxy can help you improve the quality or test of your of of tests that the tester application of any kind of local uh up any kind of application. You are running locally, the doing that is doing any kind of request to any kind of API, not only Microsoft graph or Microsoft specific apis.

A

And then then we can configure just Microsoft graph developer proxy to intercept this kind of call and provide a different response. So you can see how your app can behave, which is quite awesome and for the sake of Simplicity I developed a really simple one: viewer WPS application with just three buttons: uh okay for to to show how we can improve the test and regarding tests, what do I actually means what kind of tests I want to improve uh um with the thought?

A

Do I need do I like it when I'm meaning our unit tests integration test? Well, actually, no, because here in Newton's integration test, we are testing part of codes with code, so we can mock whatever. We are, we want not only response to any kind of request, but we can Mark any kind of response for any methods, but for sure Microsoft graph, developer proxy can help you with improving the quality of your manual or UI automated test, which is a lot better and how well, let's think of a scenario how UI, augmented tests usually works.

A

So we have like a local application like some kind of client. We want to test okay, it's really cool. We, we start developing code that will run this application click it through and along the way it turns out. This application is using many kind of apis. It's good that those those, for example, are apis that we actually manage.

A

So those are actually in our responsibility, so we can also set them up along the way as a part of this test or as a part of pipeline that will be running this test and any kind of, for example, cloud or in some kind of encapsulated behavior, so we'll have also the resources that will be created directly for this client application for this UI automated test. So this could be quite easy, but still in uh also, this imposes a big complexity and uh and some complexity in our UI automatic test scenario.

A

We need to develop what about apis that are, we can consider external sources that we don't manage. What about those? For example, yeah. We call the graph the Microsoft graph, so we cannot. We cannot like manage this because it's not our responsibility. So what what? If this fails- and it may happen from time to time? Well, then we have to just uh consider that, from time to time in our pipeline, we we may see some uh fails. That will just be a successful we run again and for sure this is some wasted time.

A

That's a developer or a tester needs to check on Department. Okay, why it says: is it actually our responsibility or was it a random error that can may happen from time to time? And what about smoking errors, though? We actually test error scenarios in UI automated tests? Well, not so much because it's really hard to develop uh this kind of test. It also imposes a national complexity.

A

Let's think of the let's wait: for example, we need to have some data and a database that is corrupt specifically for this run, and then our web API will be using this row and a specific kind of request to make it fail. So we can test a failed run, and this would we all needed to be developed as part of a setup script or a part of a pipeline that will be running before this UI.

A

Automated test will be taken care of so usually, as this imposes additional complexity or you go usually UI automated test test, the success of so when everything goes fine and with Microsoft developer proxy. We can improve each of this area. We actually won't need any additional resources, except our client up and the developer proxy console running.

A

We can mock any kind of API, not only the one we manage, so we should get rid of the the errors in our pipelines and it would be just really easy to mock errors and I will show all of those in a really simple use case in a demo which is okay, which is now okay, so I have a really simple application in WPF with a couple of buttons and I will run it now um and actually my application just signing the user from uh cache start in local file, so I don't need to even if I have multi-factor authentication, Etc I don't need to do it now and I have two buttons.

A

The first one is calling the Microsoft graph to get me my information about my personal information and since it's an API that exists, it runs and successful and the other one is actually so. This is this one: it's actually running a custom API that I didn't develop, I forgot about it, so it will always fail, but still I can send the request and wait for for a response that is actually fine. Okay, that's quite cool, so I have a client application. I would like to test with the UI automated test.

A

So now, since I didn't develop this web API. For the second call, I would need to create this additional resource storage sum or keep it whatever with Microsoft developer proxy. We don't have to do it at all. Let me just start this tool.

A

For starters, it starts in a chaos mode, so it kind of listens on the URL defined and then upsetting so Json I will show you in a bit and will randomly produce a result. It can be either success or an error from one of the predefined errors. We also can Define in the up settings Json for every call we are actually listening to so now. If I would click on the call Microsoft graph API, we can see okay, it turned out it's a success.

A

Let me let me try again: okay, again I'm really lucky today, but Okay. The third time actually I got an error. uh Gateway timeout and, as you can see, it's an EOS kind of mode, so it means that it was randomly picked. An error. I I represent this error in the text box and also Microsoft graphs, as I told you gives you additional tips, how you can improve your code, but what about my second call with my custom: API. Okay, so I click this one.

A

This one still fails because the API is not still there and Microsoft graph developer proxy. That doesn't work. Yet it doesn't show me my API yeah, because it doesn't know it needs to listen for. Okay, maybe look for the request coming to this directory URL and we can configure it really easily.

A

So let me just turn this one off, and this is the upsetting station. This was part of the Microsoft graftable products. You can configure the first thing. The big part are the plugins that we can just not present today, but you can get the feeling how it is developed at everything in Microsoft, developer proxy is a kind of a plug-in and extendable, and you can replace it with your own or attach a new one. But the important part I want to show us today is actually the URLs to watch.

A

I trim this only to look for currently for the Microsoft graph me endpoint. That's because a lot of things under heard, like also teams, are using uh Microsoft graph, so I wanted to join this call without any additional problems.

A

That's why I framed this only to look at the specific URL that if you would just download the latest pre-list 0.5 of the Microsoft developer proxy, you would have a more a bigger upsetting Json, with it's just pre-configured, to look for any kind of call to Microsoft graph and SharePoint apis, which is quite cool because all of this work is done for you and what the only thing I need to add here is just tell Microsoft craft developer proxy to listen to my additional request, which is this one, which is the custom API endpoint get test.

A

That's all, let's save it, let's rerun and now, if I will click on my custom, a custom custom button to comma custom, API, okay, it works who have a success and it's prepared because the eBay is not there. But let's you click it again. Okay, it works. So you see I got a chaos and an error. The Microsoft craftable proxy is actually aware of my request to my custom API now and it's randomly producing errors to uh to my API that just doesn't exist. So this is quite cool.

A

It means we can test a client application without any additional resource, any additional web apis. We need to store on the cloud or in our local or run locally specifically for this test, or maybe even additional databases that are retrieving data. That ypa is retrieving data from those databases to give us the the response. Okay, but this is randomly producing error, how we can create a UI, automated test that that tests a random response- that's not not quite efficient, but it's quite easy right and Microsoft graph developer proxy. We have additional a bunch of parameters.

A

One of those is providing a mock file which I would presenting today. I have developed, uh developed, look at written a really short mock Json, which is producing uh the internal server error for both of those requests just for the sake of the Simplicity. But uh if you would dive deep in the documentation which I really recommend you, because the wiki is quite big and it's really awesome- you can see that the responses you can create specifically for each request.

A

It can be either a success with a bunch of data or a specific kind of error. You would like to to respond for for any kind of request, also your apis again.

A

So, okay, let me run the Microsoft graph that will provocative with a small file. It already tells me that okay I have defined a mock for two URLs and now, if I will run either the Microsoft graph or call or my custom API call. I will always get the same response for in the scenario I actually written in the mog.json file, which is always the internal server error. So, okay, this is cool. I have a client up this.

A

Only the only thing I need Microsoft, the graph developer proxy console application working in the background and, let's say currently, a really small one, but for a UI automated test. In a big scenario, we are quite big, but a single Json file that will be producing the exact responses. I want to test. For my up. This means that I can really easily test without any additional resources, except this Json file, success scenarios and error scenarios, which is great okay. So this is uh what I will actually do.

A

I developed a really simple UI, automated test it it's not the best practice. How a test should look like. Probably most of the steps here could be set up as a part of the pipeline, or it could be in a predefined setup step, but just for the sake of Simplicity I put everything in a single.

A

You know you're in a test UI automated test and, as you can see, you don't need, even if even you have to be an owner of the app you want to like in you, don't need the source code of the app you are going to test. I just need the executable of the application. I want to start and then I want to start Microsoft graph developer proxy with a specific mock. Json I did I created specifically for this scenario.

A

One then I'm going to test, and this scenario is just clicking all the free buttons and it's looking if the response is actually an error. Okay, let's run it takes about like uh half an hour, so we're gonna, wait, I mean like 30 seconds, I hope uh unless crash so I'm, not touching the mouse. Now you have to just believe me, but you will see from the mouse movement that it's kind of like jumping from button to button, so I think it's impossible for me to do something like this with a touchpad.

A

uh Basically, in the background, we can see the developer proxy started and we already clicked on the first Microsoft drop button. Then now on my second custom, API button and now the test, the UI Automotive test will close my app and that's the end. It's not it didn't close the proxy. Why? Because I didn't read it written it in the test, only to show you what was actually done under beneath, but you can see that the test passed according to what I wanted to accept.

A

So, as you can see, the Microsoft graph developer proxy intercepted the calls and the UI automated test according to my scenario, and gave the responses I wanted it to do, and the UI automated has just passed without any additional apps resources work whatever just uh two apps and Json very cool, then go back to the slides, yeah and I. I have a recap: slide yeah this time, I prepared. So what actually proven with this really simple test case I hope that it also motivated you to give it a try. I mean give it developer proxy.

A

A try is that, with this tool, you can improve your test, the UI automatic test quality and you can get rid of those failed running tests in the pipelines, because you can now even mock responses for the apis. You don't handle this can randomly fail. Now you can just always mock it. The way you want it to run, fail or success whatever. So it's a really uh it's like saving you a lot of time, especially for the test team.

A

That would help to investigate each failing case and, as I said a bunch of times now it reduces the complexity for us developers When developing such a UI automatic tests.

A

We don't need to think about setting up an additional database additional web API for our only to test our small client application, and we don't need to do it in a pipeline or locally during the the test starts, which makes the, which is also saving us time and make me for sure happy as a developer and it's for sure saving a bit of money, especially if those were resources in the cloud we now don't need to keep so I guess the client will be also a bit happy, so it makes everybody happy just try it and I guess.

A

That's everything.

A

I wanted to say, I hope, I, really motivated you to give Microsoft product developer proxy a try and provide as much feedback as possible because it's still in the community preview, so feedback is really important, especially if you have some specific use case like this one you could you could integrate with the proxy or some other awesome ideas that could be introduced now, just from previous to priorities and it's okay to to introduce any breaking changes, and also one thing was already mentioned on this demo call is that currently there is a huge hackathon event magnitude, but I mean it's really important and Microsoft a graph.net hackathon currently running.

A

So if you haven't registered and you didn't participate yet, please do so because it's an awesome opportunity to learn how to use Microsoft graph and the dot Network. Even if you are an expert, you can always earn something new and gain more experience in this area. For sure and I guess, that's pretty much I have to say I, hope, I, wasn't listening and I didn't take too much time so I'll face my voice too. David awesome, Adam, very, very cool I! Really appreciate that excellent job foreign.