Kuzhali Maheswaran, Author at Document360 The knowledge base that scales with your product. Fri, 21 Apr 2023 09:44:12 +0000 en-US hourly 1 https://wordpress.org/?v=6.4.2 https://document360.com/wp-content/uploads/2018/06/favicon-150x150.png Kuzhali Maheswaran, Author at Document360 32 32 Test Automation Framework: How we built it for Document360 https://document360.com/blog/document360-test-automation-framework/ Thu, 13 Apr 2023 05:34:19 +0000 https://document360.com/?p=7910 Nowadays, product-based companies are expected to deliver a product in a short time. ...

The post Test Automation Framework: How we built it for Document360 appeared first on Document360.

]]>
Nowadays, product-based companies are expected to deliver a product in a short time. The testing team goes through a very thorough and strict QA process to ensure top-notch performance & quality of the final product.

In Document360, we have a portal to create content and a knowledge base site to view published content. Our team performs various types of testing like functional, performance, and security to ensure product quality. There is no debate that if companies want to improve their overall efficiency, the next step is the adoption of Automation in testing.

To ensure maximum efficiency, we decided to automate our functional testing, via various testing tools and frameworks. We compared various solutions before picking the right one based on our requirements.

Document360’s test automation framework

We developed a hybrid test framework using Selenium C# with NUnit. This improved the testing efficiency and helped to optimize total testing time. The main advantage of a Hybrid framework is that it allows us to combine any two or three other frameworks’ approaches to overcome the limitations of one framework. This brings more flexibility while doing end-to-end automation testing.

Below is the Architecture Diagram of our Document360 test automation framework.

test automation framework

Our Automation Framework has two parts,

  • Core
  • Document360

Core Library

Our core library has all the standard utilities which are required to write and execute tests right away, irrespective of the application like

  • Creating various browser driver instances
  • Selenium wrapper methods and custom methods
  • Excel Class to read the test data from the Excel file.
  • Mailer to read Outlook mail and validate its controls.
  • A web client for REST API methods (Get/Post/Put/Del)
  • Snippet methods to validate the API response.

Document360 library

Document360’s automation framework combines modular-driven and data-driven approaches, in which we split modules and organize them in the same structure as in the application. All the test data are kept separately from the script for easy maintenance.

Our framework also follows the Page Object Model (POM) design pattern. Every page, including the blade and popups in Document360, is considered an object, and separate classes are created for each page to have its web elements and methods to interact with it. All the web elements on the page are initialized using a page factory with polling intervals to avoid unnecessary wait time and “NoSuchElementException” due to external factors.

Document360 automation test framework has the following components.

Base Layer:

This Layer is a test bed for all other classes. It has pre- and post-scripts to run each test case in our automation suite.

Configuration Layer:

This Layer contains the configuration-related data and its classes. It has data like threshold limits, URLs, and credentials details for different environments (like DEV/QA/PROD) that need to be used in our application.

Test Layer:

The Test Layer comprises test classes containing the automated steps to validate the available cases and their corresponding page object classes.

Data Layer:

This Layer has all the input data needed to pass it to test scripts stored in a separate file and maintained globally to reuse it everywhere required.

API Layer:

We allow customers to integrate Document360 as an extension with helpdesk and team collaboration applications like Freshdesk, Slack, Microsoft Team, and many more.

Not all the cases from these modules can be automated through UI alone to ensure functionality, and populating the high volume of test data for modules like analytics and bulk operation is a tedious one. We addressed these kinds of challenges at the API level.

Document360 APIs are well secured, and we need a valid bearer token and project id to access Document360 portal APIs which we extracted from headers using Selenium Chrome DevTools Protocol (CDP)

This Layer has logic to read the API details to maintain in Excel and generate a request to send it to the web client and receive server responses.

Reporting

We have robust reporting mechanisms, implemented using “Extent Reports” to generate a clear report with all relevant information about the tests. We logged exceptions and screenshots in case of failure for further analysis. This Layer holds all the screenshots and reports generated for each test run.

The sample extent report dashboard with failures

extent report dashboard

Test execution using Azure pipeline

We integrated CI/CD pipeline (Azure DevOps) with our automation project to execute the automated cases and give feedback about the build quality faster.

We have set up two different pipelines, one to execute all the automated cases on the scheduler configured and another to run cases from the test suite we have in Azure Test Plan on a demand basis.

A successful outcome of our test automation

At first, we could not measure the outcome of our automation framework accurately like other automation teams, we expected test cases to fail or be unstable due to other factors.

To overcome this, we identified and ignored the flaky tests in execution to avoid misleading results. We ran the test suite constantly to fix the flakiness in tests and included it in the test run.

Once a robust framework was in place, the test cases in the regression suite were automated and stabilized. We have seen huge progress and reaped the following benefits of automation:

Saved time and effort 

Automation in the regression cycle, automated cases that required checking for different data in the suite. The execution was fast and gave us the results in a few minutes. It reduced our testing time for those cases from a day to a few hours.

Identifying bugs in the earlier stages 

We have configured our automation script to run daily This helps us to identify bugs in the early testing stage rather than the regression phase.

Conclusion

Our test automation framework uses a hybrid approach that is designed and developed to be robust, easy to maintain, scalable, and very flexible to execute end-to-end testing with all necessary features. Ultimately it’s helping us to reduce total testing time and manual tester effort.

An intuitive technical documentation software to easily add your content and integrate it with any application. Give Document360 a try!

GET STARTED
Document360

 

The post Test Automation Framework: How we built it for Document360 appeared first on Document360.

]]>
Import and Export Documentation within Document360 https://document360.com/blog/import-and-export-project-documentation/ Tue, 12 Feb 2019 14:43:39 +0000 https://document360.com/?p=1008 The Import and export capabilities are one of the major features in Document360 ...

The post Import and Export Documentation within Document360 appeared first on Document360.

]]>
The Import and export capabilities are one of the major features in Document360 which helps the user to create an Article and their Categories for their documentation in one project from the existing project without re-creating it manually. In this Blog, we are going to see how to export and import the project documentation within Document360.

Let’s say you already have one project with all documentation in proper structure. Now you need to create another knowledge base for your new customer with similar documentation and slight changes in it but with a different theme and project settings.

In this case, if the user clones the project, then a new project is created of course with similar documentation, but all the theme and settings configuration will be the same as the source project. The user has to go and change all configurations based on their new customer’s need which adds one more unnecessary step for them.

Document360 allows you to get this done quickly by exporting the documentation from an existing project and importing it to a new project created for that customer which has different project settings.

Export Documentation as .zip

When you try to export your project documentation, all the article’s content will be exported for both Markdown and WYSIWYG in the Version, Language, and time period level folder. If you require the media files in the article, these will be exported in a separate folder. All these contents will be ready to download as a compressed .zip file.

Import and export documentation in Document360

To export your documentation, go to Content tools > Import & Export > and click the “Export” button. A blade window shows you the export selection such as version, language, time period, and include media files selection. Click on the ‘Export documentation’ button, and the export process runs in the background. 

Import and export documentation in Document360

Once this background process is completed, you will see two new icons appearing in the right corner of the Export Documentation section.

Import and export documentation in Document360

Document360 allows you to download the exported documentation in two ways

1. Download the exported Documentation – You can directly click the icon to get the latest exported documentation in .zip format

2. Copy the Download link – you can copy the download link and send it to a team member of the different project to download the file and import the documents into their projects.

Import Documentation:

The exported documentation file can be imported into any project. Articles in the exported file will be imported into an existing category in the destination project if the project has a category with the same name.

Import and export documentation in Document360

To Import documentation, go to Content tools > Import & Export, and click the “Import” button. When you click the Import button, a new blade will open where you can upload the Document360 exported file. Once you upload the file, the steps involved in the import process will be displayed with the status.

1. Uploading zip file
2. Validating zip file

Import and export documentation in Document360
If the uploaded zip file is valid, the number of categories and articles in the zip file will be displayed. Using the toggle available, you can choose your article status after the export (Draft or Published). Click on the ‘Import’ button.

Articles in the exported file will be imported into the existing category if the destination project has the same name in the category section.

An intuitive knowledge base software to easily add your content and integrate it with any application. Give Document360 a try!

Get Started
Document360

Based on the file size, it will take a few seconds to minutes to complete the import process which will run in the background so that you can go to other sections and come back. Once the import process is completed, it shows the imported status with the number of categories and articles imported along with an Errors message (if any). You can also see the latest imported log information by clicking the icon that appeared after the import process completed

Export to PDF

Portable Document Format (PDF) is a universal format used for data transfer between different applications. Many applications support exporting content into PDFs such that it facilitates reliable data exchange independent of software, hardware, and operating system.

If you are planning to migrate from one platform to another, PDFs can also be used for data migration and archiving purposes. There are a few use cases that exist for converting content to PDFs namely

  • Sharing content from proprietary software to other software platforms
  • Sharing content with rich images and standard typefaces
  • Digitally sign PDFs that can be used for legal and compliance purposes
  • Migration from one platform to another

At Document360, we understood the need to export your knowledge base into PDFs to suit your use cases. Document360 support exporting your knowledge base project into PDFs. Those export PDFs can be password protected for additional security.

To access this option go to Content tools > Import & Export > Export as PDF. You can find two tabs here ‘Content templates’ and ‘Design templates’.

Import and export documentation in Document360

Document360 also provides various ‘Content template’ settings for PDF generation. The cover page and table of contents can be added as per your requirements. Document360 provides you two options: image as a watermark or plain text as your watermark if you need to embed a custom watermark to protect your copyright. All these settings can be previewed before the actual PDF generation to verify your settings. The layout of the PDF can be configured as portrait or landscape along with different margin settings.

However, to specify these design preferences, you can use the ‘Design template’ tab. Create a custom PDF design template that can be used to style the PDF to be exported. Users can configure the visual aspects like the cover page, table of content, watermark, layout, header & footer, and font settings.

Headers and footers of the PDFs can include images and page numbers, respectively. Both header and footer can be aligned to the center, left, and right. Furthermore, font face, color, and size can also be configured to suit organizational brand guidelines. Once you are done with your design, you can save the design template and use it any number of times in the future while exporting. 

Import and export documentation in Document360

Coming back to the ‘Content templates’ tab, this is similar to the design templates but instead of the style elements you choose the content elements in the Knowledge base project that goes into the PDF. 

Check out the below tutorial video:
How to export your knowledge base content to pdf using Document360 

 

Schedule a demo with one of our experts to take a deeper dive into Document360

Book A Demo
Document360

The post Import and Export Documentation within Document360 appeared first on Document360.

]]>