Pickles and living documentation for Specflow

Karthik KK
A free video tutorial from Karthik KK
Software Architect, Consultant,Youtuber and Best Seller
4.3 instructor rating • 28 courses • 243,284 students

Learn more from the full course

Automation framework development with Selenium C# (Advanced)

An End-to-End Selenium automation framework development course

15:52:08 of on-demand video • Updated January 2021

  • Understand what an automation framework is
  • Choosing right automation framework for your project
  • Building more robust and hybrid automation framework
  • Leveraging the power of C# to build generic framework model
  • Extending the automation framework with Behavioral Driven Development with Specflow
  • Developing an Industry standard framework with complete modularity on framework as well as Application test code
English [Auto] Hi, guys, my name is Kartika. I'm from Automation Dotcom, and in this video series, we're going to talk about Bechler's, a living documentation for a spectral feature file, which makes the maintenance software feature file much better and much easier than ever before. So what is Biggles? Because it's an open source living documentation generator that works on feature files, written on chokin language popularized in tool like cucumber's and spec flow. Well, because it can be incorporated into your Patroclus to produce living documentation in format that is more accessible to your clients. And Kurgan language files are written in plain text and stored in your source folder. We all know that backflow is one of the most popular BTD kind of tool which can be used for maintaining your test cases in a plain text. But that plain text is going to reside in your vehicle studios project. But if you want to export that Peter file to our client, then there is no such mechanism available out of the box in visible studio or inspect flow where you can generate that as a historical file and give it to their client. And that's where Piccolo's come into picture because actually generates a very, very handy way of exporting the feature files and scenarios into a Hesjedal file of a document and an Excel sheet or something like that. So we're going to see this picture in much detail in this video and as well as in the next video. So what are the output farmers that supports because can produce output in different formats like static e-mail as a Hestia Matthijs with minimal JavaScript. Or a dynamic extremophile or DTMF in which a JavaScript rich single page application is integrated with the search features in that, and then it also supports Microsoft Word, as I already said. And you can export that to an Excel sheet and also do a custom jasen format, so installing people is very, very easy. All you have to do is go to the package manager, console and install the package with this command install package, because we can do this installation in many different ways, like Chocolate Chocolatey Newgate is a machine package manager, somewhat like an opponent of Linux, but built with Windows in mind. So the command for installing the chocolate is Chocho install chocolaty. So let's start working with it then and start understanding how the pictures actually works. So for that, I'm going to flip through this whole studio. So this is one of the project which we created for you, because right here, the Automation Framework Development with selenium C Sharp is an advanced course for developing a framework. So the reason why I'm showing this particular chord right here is because we actually need to have a folder with features files in it, because all we are going to do with the pictures is to generate a living documentation for the feature files, which we have already written something like this. So as you can see in my next project, I have a login feature and also a employee feature with some of these scenarios in them. And this can be accessible only by a tester or a developer who is sitting or using the visual studio. But of course, you can argue this is a plaintext because it is kind of a plaintext. You can just copy this and give it to a customer or a client with a notepad format, or you can maybe give it a color to format if you copy this into a document like word document. But that's why the pixels is actually coming into the picture, because using pickerel, we can actually generate a very, very neatly designed documentations. So let's quickly see how to generate that. So far that what I'm going to do is I'm going to go to the references, so I'm just going to click and I'm going to manage Newgate packages, or I can use the package manager console and then I can select the project, which I need to install the bigger so auto est and then I'm going to type install package and pickle's. So this is the latest version while I'm recording this video. All right. So the people who got installed in my project and as you can see that I can see that booklet is only available in my project if I just. Right. Click and open the folder as an explorer. And if I go to the packages, you can see I will actually have the pictures folder right here. And that's the tool that we are going to make use of it. So how to execute this bigger? The on thing, which I'm going to do using is basically I will just start typing a command very, very easily. And as you can see, the command for generating the features into a historical file is just type something like this because of features hyphen. You can see that there really a lot of options available. Something like this just hyphen and tab. You can see there is a feature directory output directory, language test result formants test result file system under test names and all those different kinds of options, which is coming up right here. So can you actually check all these informations? Just navigate to Darkstar because dog dot com slash Ian's last latest and you can see the latest documentation for the pictures and you can see that there is a lot of greatest documentation available for the because. The reason is it is very, very simple tool. At the same time, the documentation is very, very neat. And you can see there is an argument sections if I click this arguments, you can see the different kinds of option which you can use to perform the operation. So the feature directly argument is basically for passing the directory name off the feature file. And similarly, the output directory is the directory where you have to keep the generator, has HTML file or the documents like word excellent, etc. So you can keep on learning about these kinds of argument right here and start working with it. So the first argument that which I'm going to pass in is going to be the feature directory. So very my features actually sitting in. As you can see within my particular project, I can select the root of a project just by hitting dot and then slash and just hit that. You can see it'll bring me up all the different folders within my project. So my feature file is actually sitting under the employee test folder. So I'm going to like that and I'm going to slash and then my features actually sitting under the features folder. So I'm going to start this features and this is the directory of my feature files and then I'm going to store the features generated Hesterman output file into a output directory. So I'm going to select that. So far, this video, I'm actually going to save the. Generator filed into my colon, and there is something called pickle's output, so I'm going to store it right there, right. And then I need to give some additional parameters like language, which is kind of optional because the default is English. So I can just leave as of now that this is in format and file will be looking in the next video, but we can use a name for the system under test. The system under the test name is going to be my employee app test and it can also specify the version of the system on the test. It is actually version 1.0, so I can give that, which is one point O and then I can do the documentation format. So the documentation format is going to be, as you can expect, it can be in his Gmail file, a decimal file or a word or excel. So as of now, I'm just going to use the e-mail and then I'm going to just hit enter. So as you can see, it has generated a BIGGLES file for us. I'm just going to navigate to this folder. There we go. And as you can see, there is a very, very simple hesjedal files for us. Now, if I just don't click, this industry has to email. There you go. You can see it is bringing us the informations, something like this, the test results generated for employee test, which is version 1.0, and this is the version that we gave in our visual studio. And then it also says some of the information like generated on and produced by all those informations and there is an employee and login. So if I click the employee, you can see that it's neatly bringing up the informations on the feature files. It is sitting in our little studio. And as you can see, this is the feature, this is the background, and this is the scenario with the smoke stack. And here's another scenario. So you can see all this information is neatly designed and generated for us. And if I click the log in, there we go. So this is the login information, but this is not kind of very cool. Even if we use these GML, it'll be even much cooler. So what I'm going to do, I'm just going to delete these files completely and then I'm just going to type. Instead of his GML as Distomo and hit Enter, I will once again navigate to this and right now you can see there is a JavaScript file and it is kind of even neatly designed then is static html file. So if I just open this. You can see this time it has a very brilliantly designed background, informations, scenarios, and here's the table and also you can see it can expand and minimized. And also you can see that this time it has a search feature so you can search via the tag or you can also search via the feature name. And there is a login and this is the information. So let's say I'm going to search for the positive. I'm just going to go here and going to type as positive. You can see it is also coming in the intelligence. If I do a search, it brings me up right here. Right. And also there is a link option, which you will see in our next video where you can link your test result into your living documentation so that you can see, like, how this scenario will look even much more meaningful. So there is a oryu button. So if you click this, it will show you a very, very simple report. As of now, there is nothing to show like any failures because it is all OK. But once we add a test result file, it will be more meaningful than right now. Cool. So that's it, guys. Thank you very much watching this video and have a great day.