Kovair is now part of SurgeONE.ai Same experts, even more power.

Month: April 2020

About the Partner

Paradigm is a Florida-based solution provider, offering value added alternatives that meet the highest standards and requirements for high impact industries in an increasingly competitive and changing environment. With over 20 years of experience, we expect to provide the best solutions based on our client’s needs and objectives.

 

Paradigm

Company Info

  • Company: Paradigm Telecom Solutions, INC.
  • Country: United States, Florida.
  • Address: 8865 NW 37 TH DR
  • Phone: +1 954 624 6042
  • E-mail:   ventas@paradigmtech.us
  • Website: paradigmtech.us

TFS Plugin Details

Plugin Version: 1.0.1 Last Update on: December 20, 2019

Overview

Team Foundation Server (commonly abbreviated to TFS) is a Microsoft product that provides source code management (either with Team Foundation Version Control or Git), reporting, requirements management, project management (for both agile software development and waterfall teams), automated builds, lab management, testing and release management capabilities. It covers the entire application lifecycle, and enables DevOps capabilities. TFS can be used as a back-end to numerous integrated development environments (IDEs) but is tailored for Microsoft Visual Studio and Eclipse on all platforms.

TFS Information:

More information can be found at TFS.

Version Supported:

   This plugin was developed and tested against version present on TFS 2019

Plugin Operation:

  1. CheckOutCode
Input parameter(s):
Parameter Is Mandatory Help Text
tf.exe Directory path true Installed TFS Path, Note: If this is invalid the file download will be stucked Ex: C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer\tf.exe
Mapped Workspace Directory true Mapped path with TFS. If no workspace is mapped with the given path the files won’t download Ex : C:/Demo
All false You can use this option to restore an item that you have accidentally deleted from a server workspace. (This is the command-line ‘/all’ option
Overwrite false

By default, the system does not retrieve an item if it is writable

that is, if its read-only attribute is cleared) on the client machine.

This option overrides the default behavior and overwrites a writable item, unless the item is checked out. (This is the command-line ‘/overwrite’ option)
Force false Combines /all and /overwrite. (This is the command-line ‘/force’ option)
Recursive false Recursively gets items in the specified directory and any subdirectories. (This is the command-line ‘/recursive’ option)
Output parameter(s):
Parameter Help Text
FilePath Filepath where the files are been downloaded.
IsFilesPresent Is download Successfull.
TFSStatus Final CheckOutCode job status.
Pass/Fail Condition:
Status Condition
Passed All Path should be valid. Downloaded file should be physically present in the path provided in configuration
Failed Outputlog should contain ‘Unable to determine the workspace’.
  1. IsMappingExist
Input parameter(s):
Parameter Is Mandatory Help Text
tf.exe Directory path true Installed TFS Path, Note: If this is invalid the file download will be stucked Ex: C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer\tf.exe
Mapped Workspace Directory true Mapped path with TFS. If no workspace is mapped with the given path the files won’t download
Workspace Name true Check the Workpspace whether path is mapped or notworkspace. (This is the command-line ‘/all’ option
Output parameter(s):
Parameter Help Text
FilePath Filepath where the files are been downloaded.
WorkspaceName Name of the workspace
TFSStatus Final IsMappingExist job status.
Pass/Fail Condition:
Status Condition
Passed Outputlog should contain ‘Mapped Workspace Directory’.
Failed Outputlog should contain ‘does not exist’ or ‘Mapped Workspace Directory’ not found.
  1. CreateAndMapWorkspace
Input parameter(s):
Parameter Is Mandatory Help Text
tf.exe Directory path true Installed TFS Path, Note: If this is invalid the file download will be stucked Ex: C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer\tf.exe
Mapped Workspace Directory true Mapped path with TFS. If no workspace is mapped with the given path the files won’t download
Root Directory true Check the Workpspace whether path is mapped or not. (This is the command-line ‘/all’ option
TFS URL true The URL of Team Foundation Server i.e.http://<domain>:<port>/tfs
Source Control Folder true The path that will be mapped with local folder
Workspace Name true Name of the Workspace
Output parameter(s):
Parameter Help Text
FilePath Filepath where the files are been downloaded.
WorkspaceName Name of the workspace
TFSStatus Final CreateAndMapWorkspace job status.
Pass/Fail Condition:
Status Condition
Passed If the outputlog is empty.
Failed Outputlog should contain ‘is already mapped in workspace’ or or ‘already exists on computer’
  1. DeleteWorkspace
Input parameter(s):
Parameter Is Mandatory Help Text
tf.exe Directory path true Installed TFS Path, Note: If this is invalid the file download will be stucked Ex: C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer\tf.exe
Workspace Name true Name of the Workspace
Output parameter(s):
Parameter Help Text
WorkspaceName Is Delete Successfull.
TFSStatus Final DeleteWorkspace job status.
Pass/Fail Condition:
Status Condition
Passed If the outputlog is empty.
Failed Outputlog should contain ‘does not exist.’

Disclaimers:

  1. Conflicts cannot be handle using this plugin.

Release Details:

TFS: 1.0.1 Initial version with basic functionalities

Contact us:

    Yes, I accept the Privacy Statement and want to receive latest information from Kovair.

    [tracking]

    SonarQube Plugin Details

    Plugin Version: 1.0.0
    Last Update on: December 10, 2019

    Overview

    SonarQube is an open-source platform developed by SonarSource for continuous inspection of code quality to perform automatic reviews with static analysis of code to detect bugs, code smells, and security vulnerabilities on 20+ programming languages.

    SonarQube:

    More information can be found at SonarQube.

    Version Supported:

    This plugin was developed and tested against SonarCloud(https://sonarcloud.io/). SonarScanner 4.2 is used for code analysis (Ref : https://docs.sonarsource.com/sonarqube/latest/analyzing-source-code/scanners/sonarscanner/)

    Plugin Operation:

    1. Run Code Analysis This operation allows to code analysis using SonarQube.

    Input parameter(s):

    Parameter Is Mandatory Help Text
    Url true Sonarqube Cloud Url(https://sonarcloud.io)
    Token true Sonarqube Token.
    SonarqubeScanner Path true SonarqubeScanner file path (Ex: C:\\sonar-scanner-windows\\bin\\sonar-scanner.bat).
    Project Path true Project Path (Ex: C:\\DemoAspProject)
    ProjectKey true Sonarqube ProjectKey
    Organization true Sonarqube Organization

    Output parameter(s):

    Parameter Help Text
    SonarqubeStatus Status of the Operation

    Pass/Fail Condition:

    Status Condition
    Passed Outputlog should contain ‘EXECUTION SUCCESS’
    Failed If outputlog does not contain ‘EXECUTION SUCCESS’ or some internal error occurs.


    2. Analysis Report This operation allows to fetch code analysis report(Quality Gate,Bugs,Vulnerabilities etc).

    Input parameter(s):

    Parameter Is Mandatory Help Text
    Url true Sonarqube Cloud Url(https://sonarcloud.io)
    Token true Sonarqube Token.
    ProjectKey true Sonarqube ProjectKey

    Output parameter(s):

    Parameter Help Text
    Quality Gate Quality Gate.
    Bugs Total bugs.
    Vulnerabilities Vulnerabilities.
    Code Smells Code Smells.
    Coverage Coverage.
    Duplications Duplications.
    Lines of Code Lines of Code.
    SonarqubeStatus Status of the Operation

    Pass/Fail Condition:

    Status Condition
    Passed If basecomponent in console outputlog contains required data.
    Failed If basecomponent in console outputlog does not contains required data. or some internal error occurs.


    3. Get Issues This operation allows to get top 100 issues from sonarqube.

    Input parameter(s):

    Parameter Is Mandatory Help Text
    Url true Sonarqube Cloud Url(https://sonarcloud.io)
    Token true Sonarqube Token.
    ProjectKey true Sonarqube ProjectKey

    Output parameter(s):

    Parameter Help Text
    Issue Count Issue Count.
    SonarqubeStatus Status of the Operation

    Pass/Fail Condition:

    Status Condition
    Passed If outputlog contains the issue list.
    Failed If outputlog does not contains the issue list or some internal error occurs.

    Disclaimers:

    1. User should have account in sonarcloud as the adapter is developed for sonarcloud(https://sonarcloud.io/).
    2. Sonarqube scanner(https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/) should be installed in Agent machine.
    3. This plugin will not work with Maven, Make and Gradle.

    Release Details:

    SonarQube Plugin: 1.0.0
    Initial version with basic functionalities

    Contact us:

      Yes, I accept the Privacy Statement and want to receive latest information from Kovair.

      [tracking]

      Slack Plugin Details

      Plugin Version: 1.0
      Last Update on: February 25, 2020

      Overview

      Slack is a cloud-based proprietary instant messaging platform developed by Slack Technologies. Slack provides a smart alternative to corporate email system.
      This plug-in has been designed to manage Slack Teams from Kovair DevOps platform.

      Slack Information:

      More information can be found at Slack.

      Version Supported:

      Slack SAAS (Cloud).

      Plugin Operations:

      1. GetChannelDetails
      Gets a channel details by channel ID.

      Input parameter(s):

      Parameter Is Mandatory Help Text
      OAuth Access Token true The OAuth Access Token of the Slack Integration App.
      Channel ID true The ID of the channel whose details will be fetched.

      Output parameter(s):

      Parameter Help Text
      StatusCode HTTP Status Code of REST call.
      Status Status of the operation.
      OutputLog Response message content.
      1. CreateChannel
      Initiates a public or private channel-based conversation.

      Input parameter(s):

      Parameter Is Mandatory Help Text
      OAuth Access Token true The OAuth Access Token of the Slack Integration App.
      Name true The name of the channel to be created. Must follow the naming rules / conventions of Slack.
      Type true Set whether the new channel will be a public or private one.

      Output parameter(s):

      Parameter Help Text
      StatusCode HTTP Status Code of REST call.
      Status Status of the operation.
      ChannelID Identifier of the newly created channel.
      1. RenameChannel
      Renames a channel.

      Input parameter(s):

      Parameter Is Mandatory Help Text
      OAuth Access Token true The OAuth Access Token of the Slack Integration App.
      Channel ID true The ID of the channel whose name should be renamed.
      New Name true The new name of the channel. Must follow the naming rules / conventions of Slack.

      Output parameter(s):

      Parameter Help Text
      StatusCode HTTP Status Code of REST call.
      Status Status of the operation.
      ChannelName New name of the channel.
      1. SetTopicOfChannel
      Sets the topic of the channel.

      Input parameter(s):

      Parameter Is Mandatory Help Text
      OAuth Access Token true The OAuth Access Token of the Slack Integration App.
      Channel ID true The ID of the channel.
      Topic true Provide the topic of the channel (max 250 characters allowed by API).

      Output parameter(s):

      Parameter Help Text
      StatusCode HTTP Status Code of REST call.
      Status Status of the operation.
      OutputLog Response message content.
      1. SetPurposeOfChannel
      Sets the purpose of the channel.

      Input parameter(s):

      Parameter Is Mandatory Help Text
      OAuth Access Token true The OAuth Access Token of the Slack Integration App.
      Channel ID true The ID of the channel.
      Purpose true Provide the purpose of the channel.

      Output parameter(s):

      Parameter Help Text
      StatusCode HTTP Status Code of REST call.
      Status Status of the operation.
      OutputLog Response message content.
      1. ArchiveChannel
      Archives the conversations of the channel.

      Input parameter(s):

      Parameter Is Mandatory Help Text
      OAuth Access Token true The OAuth Access Token of the Slack Integration App.
      Channel ID true The ID of the channel.

      Output parameter(s):

      Parameter Help Text
      StatusCode HTTP Status Code of REST call.
      Status Status of the operation.
      OutputLog Response message content.
      1. UnarchiveChannel
      Un-archives the conversations of the channel.

      Input parameter(s):

      Parameter Is Mandatory Help Text
      OAuth Access Token true The OAuth Access Token of the Slack Integration App.
      Channel ID true The ID of the channel.

      Output parameter(s):

      Parameter Help Text
      StatusCode HTTP Status Code of REST call.
      Status Status of the operation.
      OutputLog Response message content.
      1. SetReminder
      Creates a reminder.
      Parameter Is Mandatory Help Text
      OAuth Access Token true The OAuth Access Token of the Slack Integration App.
      Text true The reminder text.
      Time true The time (in future) when reminder will be trigerred. This should come in the following format:
      yyyy-MM-dd HH:mm:ss
      User false The user for which reminder will be trigerred. As per API requirement, please provide user’s member ID as parameter value (e.g.: UU2SYEK7U). If not provided, reminder will be created for the user who is invoking the API.

      Output parameter(s):

      Parameter Help Text
      StatusCode HTTP Status Code of REST call.
      Status Status of the operation.
      OutputLog Response message content.
      1. PostMessage
      Sends a message to a channel.
      Parameter Is Mandatory Help Text
      OAuth Access Token true The OAuth Access Token of the Slack Integration App.
      Channel ID true The ID of the channel where message should be posted.
      Text true The message to be posted.

      Output parameter(s):

      Parameter Help Text
      StatusCode HTTP Status Code of REST call.
      Status Status of the operation.
      MessageTimeStamp Unique timestamp of message in the channel.
      1. SchedulePostingMessage
      Schedules a message to be sent to a channel in future.
      Parameter Is Mandatory Help Text
      OAuth Access Token true The OAuth Access Token of the Slack Integration App.
      Channel ID true The ID of the channel where message should be posted.
      Text true The message to be posted.
      Time true The time (in future) when message will be posted. This should come in the following format:
      yyyy-MM-dd HH:mm:ss

      Output parameter(s):

      Parameter Help Text
      StatusCode HTTP Status Code of REST call.
      Status Status of the operation.
      ScheduledMessageID Unique ID of the scheduled message.

      Pass / Fail Conditions:

      Method Status Condition
      All methods Passed If Status   = true 
      All methods Failed If Status   = false 

      Disclaimers / Limitations:

      1. Connectivity with Slack SAAS environment must be ensured.
      2. Rich Text Formatting in message to be posted via Plug-in is currently not supported.
      3. Since Slack only allows app based API communication, hence the integration with Slack must be done by creating an App with adequate user token scopes and the same has to be uploaded in Slack. For more, please visit: https://api.slack.com
      4. User Token scopes required:
        • calls:read
        • channels:read
        • channels:write
        • chat:write
        • groups:read
        • groups:write
        • identity:basic
        • im:read
        • im:write
        • links:read
        • mpim:read
        • reminders:read
        • reminders:write
      5. The App’s OAuth Access Token must be used as security parameter to connect with Slack. Follow the steps to get the OAuth Access Token of your Slack App:
        • While being logged into Slack, visit https://api.slack.com/apps
        • Click on the appropriate app from the list named ‘Your Apps’
        • In the next UI, go to the section ‘Features’ appearing on the left pane, click ‘OAuth & Permissions’
        • Copy the value of OAuth Access Token

      Release Details:

      Slack: 1.0
      Initial version with basic functionalities

      Contact us:

        Yes, I accept the Privacy Statement and want to receive latest information from Kovair.

        [tracking]

        ServiceNow Plugin Details

        Plugin Version: 1.0.0 Last Update on: March 25, 2020

        Overview

        ServiceNow is a ticketing tool used to manage Technology Service Management tasks.It provides a centralized service catalog for personnel to request for technology services or information about applications and processes that are being used in the system.

        Version Supported:

        Orlando

        Plugin Operation:

        1. Get Record This operation allows to fetch the details of a record in ServiceNow. Input parameter(s):
        Parameter Is Mandatory Help Text
        Url true Provide the ServiceNow instance Url. Ex – https://instance.service-now.com
        Username true Provide the User Name required to login to ServiceNow instance.
        Password true Provide the correct password required to login to ServiceNow instance.
        Entity true Choose an Entity of ServiceNow.
        Entity Id true Provide the Entity Id (Number or Sys Id) of a ServiceNow record. Ex – INC0010002 or 5bee37f1db1b00103eda9235ca961950
        Output parameter(s):
        Parameter Help Text
        Record Number Displays the ServiceNow record’s Number field’s value.
        Record SysId Displays the ServiceNow record’s Sys Id field’s value.
        Field Details Displays all the attributes, along with their values, of a record in Service Now.
        2. Create Record This operation allows to create a record a in ServiceNow. Input parameter(s):
        Parameter Is Mandatory Help Text
        Url true Provide the ServiceNow instance Url. Ex – https://instance.service-now.com
        Username true Provide the User Name required to login to ServiceNow instance.
        Password true Provide the correct password required to login to ServiceNow instance.
        Project true Shows the project name in ServiceNow, which is ‘Default’ everytime.
        Entity true Choose an Entity of ServiceNow.
        Field true Fields of the selected entity of ServiceNow.
        Output parameter(s):
        Parameter Help Text
        Record Number Displays the newly created ServiceNow record’s Number field’s value.
        Record SysId Displays the ServiceNow record’s Sys Id field’s value.
        3. Update Record This operation allows to modify the details of an existing record in ServiceNow. Input parameter(s):
        Parameter Is Mandatory Help Text
        Url true Provide the ServiceNow instance Url. Ex – https://instance.service-now.com
        Username true Provide the User Name required to login to ServiceNow instance.
        Password true Provide the correct password required to login to ServiceNow instance.
        Project true Shows the project name in ServiceNow, which is ‘Default’ everytime.
        Entity true Choose an Entity of ServiceNow.
        Entity Id true Provide the Entity Id (Number or Sys Id) of a ServiceNow record. Ex – INC0010002 or 5bee37f1db1b00103eda9235ca961950
        Field true Fields of the selected entity of ServiceNow, whose details are to be modified.
        Output parameter(s):
        Parameter Help Text
        Record Number Displays the newly created ServiceNow record’s Number field’s value.
        Record SysId Displays the ServiceNow record’s Sys Id field’s value.
        4. Delete Record This operation allows to delete an existing record in ServiceNow. Input parameter(s):
        Parameter Is Mandatory Help Text
        Url true Provide the ServiceNow instance Url. Ex – https://instance.service-now.com
        Username true Provide the User Name required to login to ServiceNow instance.
        Password true Provide the correct password required to login to ServiceNow instance.
        Entity true Choose an Entity of ServiceNow.
        Entity Id true Provide the Entity Id (Number or Sys Id) of a ServiceNow record. Ex – INC0010002 or 5bee37f1db1b00103eda9235ca961950
        Output parameter(s):
        Parameter Help Text
        Status Status of the Delete operation in ServiceNow.
         

        Pass/Fail Condition:

        Status Condition Method
        Passed If GET api call sends a response code of 200, i.e, when the specified record is found in ServiceNow. Get Record
        Failed If the response code sent by the API call is not 200. Get Record
        Passed If the API call sends the response code 201 Create Record
        Failed If a response code other than the success code is returned. Create Record
        Passed If the API call sends the response code 200 Update Record
        Failed If a response code other than the success code is returned. Update Record
        Passed If the specified record is successfully deleted in ServiceNow with a response code 204 from the API call. Delete Record
        Failed If a response code other than the success code is returned. Delete Record

        Limitations:

        1. Only Editable fields are exposed for ServiceNow. This is applicable for the fields getting exposed from both the API call, being used to fetch the fields, and from the FieldConfig.xml file. Readonly fields will be skipped from being exposed.
        2. It will take quite some time to load all the fields when Create Record or Update Record operations are chosen.
        3. Reference type fields are not exposed in this plugin.
        4. Date or Date-time values are to be given in the format ‘yyyy-mm-dd HH:mm:ss’.
        5. Comments are to be added by the ‘Comments’ field which is exposed.

        Release Details:

        Service Now Rest(Orlando) Initial version with basic functionalities like GET/CREATE/UPDATE/DELETE Records.

        Contact us:

          Yes, I accept the Privacy Statement and want to receive latest information from Kovair.

          [tracking]

          Selenium Plugin Details

          Plugin Version: 1.0.1
          Last Update on: December 26, 2019

          Overview

          Selenium is a portable framework for testing web applications. Selenium provides a playback tool for authoring functional tests without the need to learn a test scripting language (Selenium IDE). It also provides a test domain-specific language to write tests in a number of popular programming languages, including C#, Groovy, Java, Perl, PHP, Python, Ruby and Scala. The tests can then run against most modern web browsers. Selenium runs on Windows, Linux, and macOS. It is open-source software released under the Apache License 2.0.

          Selenium Information:

          More information can be found at Selenium

          Version Supported:

          This plugin was developed and tested against version present on Selenium 3.141.59

          Plugin Operation:

          1. ExecuteTestSuite
          This operation allows to execute a TestNG test suite:

          Input parameter(s):

          Parameter Is Mandatory Help Text
          Classpath true Classpath of the project. Ex: C:\Demo\.m2\repository\junit\junit\3.8.1\junit-3.8.1.jar;C:\Demo\.m2\repository\org\seleniumhq\selenium\selenium-java\2.41.0\selenium-java-2.41.0.jar
          Test Suite Path true Path of the test suite that will be executed.Ex: E:/Devops/TestApplication/NewTestNGSuite.xml
          Test Result Output Directory false Indicate the directory path where the test result data files will be stored.Ex: E:\Devops\Selenium

          Output parameter(s):

          Parameter Help Text
          TestResultOutputDirectory Test Result Output Directory
          SeleniumStatus Final ExecuteTestSuite job status.

          Disclaimer:

          1. Agent service and project should be on the same server.

          Release Details:

          Selenium: 1.0.1
          Initial version with basic functionalities.

          Contact us:

            Yes, I accept the Privacy Statement and want to receive latest information from Kovair.

            [tracking]

            MS Build Plugin Details

            Plugin Version: 1.0.1
            Last Update on: December 20, 2019

            Overview

            The Microsoft Build Engine is a platform for building applications. This engine, which is also known as MSBuild, provides an XML schema for a project file that controls how the build platform processes and builds software. Visual Studio uses MSBuild, but it doesn’t depend on Visual Studio. By invoking msbuild.exe on your project or solution file.

            MSBuild Information:

            More information can be found at  MSBuild.

            Version Supported:

            This plugin was developed and tested against version present on Visual Studio 2017 and 2019.

            Plugin Operation:

            1. BuildProject
              2. This operation allows to build a project:

              Input parameter(s):

              Parameter Is Mandatory Help Text
              Project Path true Visual studio project file directory path. Note. During publish any service if a project path have mutiple service then mention th exact location.
              Ex : C:\Visual Studio 2013\Projects\abc.csproj
              MSBuild.exe Path true MSBuild.exe directory path.Ex: C:\Program Files (x86)\MSBuild\12.0\Bin

              Output parameter(s):

              Parameter Help Text
              MSBuildStatus Final BuildProject job status.
              BuildStartTime Time when the build was started.
              BuildTime Total time taken to build the project.

              Pass/Fail Condition:

              Status Required string in outputlog
              Passed ‘Build succeeded.’
              Failed ‘Build FAILED.’ or any error occurs in execution.
            2. PublishProject
              3. This operation allows to publish a project:

              Input parameter(s):

              Parameter Is Mandatory Help Text
              Project Path true Visual studio project file directory path. Note. During publish any service if a project path have mutiple service then mention th exact location.
              Ex : C:\Visual Studio 2013\Projects\abc.csproj
              MSBuild.exe Path true MSBuild.exe directory path.
              Ex: C:\Program Files (x86)\MSBuild\12.0\Bin
              Profile Name false Visual Studio publish profile name Note: If no profile present leave this field as empty
              Publish Path false Target Location, Note: will be published with default configuration.Ex : C:\Visual Studio 2013\Projects\Publish

              Output parameter(s):

              Parameter Help Text
              MSBuildStatus Final BuildProject job status.
              BuildStartTime Time when the build was started.
              BuildTime Total time taken to build the project.

              Pass/Fail Condition:

              Status Required string in outputlog
              Passed ‘Build succeeded.’
              Failed ‘Build FAILED.’ or any error occurs in execution.

            Disclaimer:

            1. If more than one project is present in the project path,correct project name should be specified in the project path.
            2. Only website type project will be published using PublishProject method.
            3. Microsoft provides various options, that can be supplied while building/publishing projects in the build command. such options are not supported currently.

            Release Details:

            MS Build: 1.0.1
            Initial version with basic functionalities.

            Contact us:

              Yes, I accept the Privacy Statement and want to receive latest information from Kovair.

              [tracking]

              MicroServices Plugin Details

              Plugin Version: 1.0
              Last Update on: February 27, 2020

              Overview

              This plugin can be used to send REST API calls using an API resource URL and HTTP headers.

              Version Supported:

              Not Applicable

              Plugin Operation:

              1. DoRequest

              This operation allows to send an API request.

              Input parameter(s):

              Parameter Is Mandatory Help Text
              Basic Auth Username False Provide the User Name needed for Basic Authentication of a request
              Basic Auth Password False Provide the Password needed for Basic Authentication of a request
              Url True Provide the API resource url. Ex: http://192.168.12.141:8080/rest/api/2/issue/HSBCPRJ01-6
              Method True The desired operation to be performed on the API Url. Ex:
              GET / PUT / POST / DELETE

              Header_Accept

              		 True Specify the media type acceptable for the response. Ex: application/json.

              Header_ContentType

              		 True The Media type of the body of the request (used with POST and PUT requests) Ex:
              application/json

              Additional Headers

              		 False Specify some additional components of the header section of request with new line separator. Ex: Field Name1 : Field Value1
              Field Name2 : Field Value2

              Request Body

              		 False

              Data to be sent along with the headers of the request. Ex:
              {

              “project” : 10000,

              “issuetype” : 10001,

              “fields”:{

              “summary” : “Story 1 mod”

              }

              }
              Output parameter(s):
              Parameter Help Text
              Response Body Message Body of the response returned for a request.
              Response Headers All the headers associated with the response.
              Status Code HTTP Status Code of the response
              Pass/Fail Condition:
              Status Required string in outputlog
              Passed If the HTTP status code is returned 200 or 201 or 204 the request will be treated as a Success.
              Failed If the HTTP status code is returned as anything other than the ones mentioned in the Passed conditions, then it will be treated as a Failure.

              Disclaimer:

              1. The fields chosen as Output parameters might not be visible in the Console Log, if one of them returns very large data.
              2. Only requests with Basic Authentication is supported.

              Release Details:

              MicroServices: 1.0
              Initial version with basic functionalities.

              Contact us:

                Yes, I accept the Privacy Statement and want to receive latest information from Kovair.

                [tracking]

                Maven Plugin Details

                Plugin Version: 1.0.1
                Last Update on: December 26, 2019

                Overview

                Maven is a build automation tool used primarily for Java projects.
                Maven addresses two aspects of building software: first, it describes how software is built, and second, it describes its dependencies. Unlike earlier tools like Apache Ant, it uses conventions for the build procedure, and only exceptions need to be written down. An XML file describes the software project being built, its dependencies on other external modules and components, the build order, directories, and required plug-ins. It comes with pre-defined targets for performing certain well-defined tasks such as compilation of code and its packaging.

                Maven Information:

                More information can be found at Maven.

                Platform Support:

                Windows, Linux.

                Version Supported:

                This plugin was developed and tested against version present on Maven 3.6.1

                Plugin Operation:

                1. RunMaven
                This operation allows to execute a maven command:

                Input parameter(s):

                Parameter Is Mandatory Help Text
                Working Directory true Provide the directory where the Maven project is located. There should be a pom.xml file properly configured in this location
                Command true Provide the Maven command to execute.Ex : mvn clean test
                Errors false Produce execution error messages
                Debug false Produce execution debug output
                Never Fail false NEVER fail the build, regardless of project result
                Fast Fail false Stop at first failure in reactorized builds
                Fail at the end false Only fail the build afterwards; allow all non-impacted builds to continue

                Output parameter(s):

                Parameter Help Text
                MavenStatus Final RunMaven job status.
                Total Time Duration to execute the command
                Finished At Command execution completion time

                Pass/Fail Conditions:

                Status Required string in outputlog
                Passed ‘BUILD SUCCESS’
                Failed Below mentioned string will result into error.
                1) ‘BUILD FAILURE’
                2) ‘Unrecognized option:’
                3) ‘not recognized’
                4) ‘not recognized as an internal or external command’
                or any error occurs in execution.

                Disclaimer:

                1. Normal cmd command can also be executed, only if other additional attribute has not been specified.

                Release Details:

                Maven: 1.0.1
                Initial version with basic functionalities.

                Contact us:

                  Yes, I accept the Privacy Statement and want to receive latest information from Kovair.

                  [tracking]

                  Kubernetes Plugin Details

                  Plugin Version: 1.0
                  Last Update on: February 27, 2020

                  Overview

                  Kubernetes (commonly stylized a K8s) is an open-source container-orchestration system for automating application deployment, scaling, and management. It was originally designed by Google, and is now maintained by the Cloud Native Computing Foundation. It aims to provide a “platform for automating deployment, scaling, and operations of application containers across clusters of hosts”. It works with a range of container tools, including Docker. Many cloud services offer a Kubernetes-based platform or infrastructure as a service (PaaS or IaaS) on which Kubernetes can be deployed as a platform-providing service. Many vendors also provide their own branded Kubernetes distributions.

                  This plug-in has been designed to manage Kubernetes Cluster from Kovair DevOps platform.

                  Kubernetes Information:

                  More information can be found at Kubernetes

                  Version Supported:

                  This plugin was developed and tested against Kubernetes v.1.17

                  Plugin Operations:

                  1. DeployFile
                  This operation deploys a file in Kubernetes Cluster.

                  Input parameter(s):

                  Parameter Is Mandatory Help Text
                  File Name true Provide the name of the file to be created along with file extension. For Kubernetes, it makes sense to deploy a JSON or a YAML file.
                  Deployment Location true Provide the location in the system where Agent Service is running and where the file will be deployed, this should start from Linux file system root (/). Please ensure necessary privileges of the user account in the provided path through which the Agent Service is running.
                  File Content true Provide the content of the file here.
                  Note: This operation has been provided to assist in file deployment in Kubernetes Master using basic Linux command. All the parameters are required for this operation.

                  Output parameter(s):

                  Parameter Help Text
                  Status Status of file deployment operation.
                  DeployedAt Location where file has been deployed. Value in this output parameter will be obtained only when deployment has been successful.
                  1. DeleteFile
                  This operation deletes the specified file.

                  Input parameter(s):

                  Parameter Is Mandatory Help Text
                  File Path true Provide the complete path of the file starting from Linux file system root(/) with file extension.Please ensure necessary privileges of the user account in the provided path through which the Agent Service is running.

                  Output parameter(s):

                  Parameter Help Text
                  Status Status of file delete operation.
                  1. CreateNamespace
                  This operation creates namespace in Kubernetes Cluster.

                  Input parameter(s):

                  Parameter Is Mandatory Help Text
                  Namespace Name false Provide the name of the namespace to be created in the cluster. Ensure following Kubernetes’s naming convention.
                  File Path false Provide the path of JSON/YAML file based on which new namespace will be created. The JSON/YAML file should be physically present in the system where command will be run.
                  Note: End user need to provide value for either ‘Namespace Name’ or ‘File Path’. If ‘Namespace Name’ is provided, then Namespace will be created based on the supplied value; if ‘File Path’ is provided, the Namespace will be created based on the template file whose path is provided. If both are provided, then ‘File Path’ parameter value will be considered.

                  Output parameter(s):

                  Parameter Help Text
                  Status Status of namespace create operation.
                  OutputLog Output log of the operation.
                  1. CreateJob
                  This operation creates a normal/scheduled job in Kubernetes Cluster.

                  Input parameter(s):

                  Parameter Is Mandatory Help Text
                  Job Name false Provide the name of the job to be created.Ensure following Kubernetes’s naming convention.
                  Image Name false Provide the name of the Image to be used in job creation.
                  File Path false Provide the path of the JSON/YAML file in which the job is defined.Please ensure necessary privileges of the user account in the provided path through which the Agent Service is running.
                  Note: End user need to provide value for either ‘Job Name’ and ‘Image Name’ or ‘File Path’. If ‘Job Name’ and ‘Image Name’ are provided, then Job will be created based on the supplied values; if ‘File Path’ is provided, the Job will be created based on the template file whose path is provided. If all are provided, then ‘File Path’ parameter value will be considered.

                  Output parameter(s):

                  Parameter Help Text
                  Status Status of job creation operation.
                  OutputLog Output log of the operation.
                  1. CheckJobStatus
                  This operation checks the status of the specified job.

                  Input parameter(s):

                  Parameter Is Mandatory Help Text
                  Job Name true Provide the name of the job whose status is to be checked.

                  Output parameter(s):

                  Parameter Help Text
                  Status Status of the operation.
                  OutputLog Output log of the operation.
                  1. DeleteJob
                  This operation deletes the specified job.

                  Input parameter(s):

                  Parameter Is Mandatory Help Text
                  Job Name true Provide the name of the job which is to be deleted.

                  Output parameter(s):

                  Parameter Help Text
                  Status Status of job delete operation.
                  OutputLog Output log of the operation.
                  1. CreateDeployment
                  Creates a deployment or job to manage the created container(s).

                  Input parameter(s):

                  Parameter Is Mandatory Help Text
                  Deployment Name false Provide the name of the deployment to be created.
                  Image Name false Provide the name of the image to be used while creating the deployment.
                  Other Optional Parameters false Provide other optional flags for creating a deployment. e.g.: Replicas / Environment Variables / Port etc. maintaining proper syntax.
                  File Path false Provide the path of JSON/YAML file based on which new deployment will be created. Please ensure necessary privileges of the user account in the provided path through which the Agent Service is running.
                  Note: End user need to provide value for either ‘Deployment Name’ and ‘Image Name’ together or ‘File Path’ alone. If ‘Deployment Name’ and ‘Image Name’ are provided, then Deployment will be created based on the supplied values; if ‘File Path’ is provided, then Deployment will be created based on the template file whose path is provided. The parameter ‘Other Optional Parametes’ may be kept blank and if value is provided for it, then it will be considered only if user provides values for ‘Deployment Name’ and ‘Image Name’. However, if user provides values for ‘Deployment Name’, ‘Image Name’ as well as for ‘File Path’, then ‘File Path’ value will not be considered and deployment will be made based on values of ‘Deployment Name’ and ‘Image Name’ and ‘Other Optional Parameters’ (if present).

                  Output parameter(s):

                  Parameter Help Text
                  Status Status of deployment operation.
                  OutputLog Output log of the operation.
                  1. ExecuteGenericCommand
                  This operation executes the supplied command in Kubernetes Cluster.

                  Input parameter(s):

                  Parameter Is Mandatory Help Text
                  Command true Provide the command here.

                  Output parameter(s):

                  Parameter Help Text
                  Status Status of the execution of command.
                  OutputLog Output log of the operation.

                  Pass/Fail Conditions:

                  Status Condition Method
                  Passed If ‘OutputLog’ is empty. DeployFile / DeleteFile
                  Failed If ‘OutputLog’ is not empty. DeployFile / DeleteFile
                  Passed If ‘OutputLog’ contains the word ‘created’. CreateNamespace / CreateJob / CreateDeployment
                  Failed If ‘OutputLog’ does not contain the word ‘created’. CreateNamespace / CreateJob / CreateDeployment
                  Passed If ‘OutputLog’ contains the word ‘deleted’. DeleteJob
                  Failed If ‘OutputLog’ does not contain the word ‘deleted’. DeleteJob
                  Passed If ‘OutputLog’ does not contain the word ‘not found’. CheckJobStatus
                  Failed If ‘OutputLog’ contains the word ‘not found’. CheckJobStatus
                  Passed If ‘OutputLog’ does not contain the word ‘error’. ExecuteGenericCommand
                  Failed If ‘OutputLog’ contains the word ‘error’. ExecuteGenericCommand

                  Limitations:

                  1. This plugin will work in Linux environment.
                  2. Kubernetes API Server & Kubernetes Command Line Interface (kubectl) must be installed in the Kubernetes Cluster.
                  3. The functionality solely depends on Kubernetes Command Line Interface, if the command behaviour changes the result may vary.

                  Release Details:

                  Kubernetes: 1.0
                  Initial version with basic functionalities.

                  Contact us:

                    Yes, I accept the Privacy Statement and want to receive latest information from Kovair.

                    [tracking]

                    Jira Plugin Details

                    Plugin Version: 1.0.1
                    Last Update on: December 20, 2019

                    Overview

                    JIRA is a project management tool used for issues and bugs tracking system. It is widely used as an issue-tracking tool for all types of testing.

                    Jira Information

                    More information can be found at Jira.

                    Version Supported:

                    This plugin was developed and tested against version present on Jira Cloud

                    Plugin Operation:

                    CreateIssue This operation allows to execute a job:

                    Input parameter(s):

                    Parameter Is Mandatory Help Text
                    Url true Jira instance Url. Ex – http://localhost:8080
                    Username true Jira login username.
                    Password true Jira login password.
                    Project true Jira projects of the given instance.
                    Entity true Jira issue type of the selected project.
                    Field true Jira fields of the selected issue type.
                    Note : As per the given credentials, input params may vary. Projects,Entities & Fields are dynamically populated based on the instance details provided in the security params (Url,Username,Password).

                    Output parameter(s):

                    Parameter Help Text
                    IssueId Id of the issue created
                    IssueKey Key of the issue created
                    JiraStatus Final CreateIssue job status.

                    Pass/Fail Condition:

                    Status Condition
                    Passed If the Issue in jira successfully get created and no error occurs in fetching/pushing data from jira.
                    Failed If the Issue in jira failed to create or any error occurs in feching/pushing data from jira.
                    1. UpdateIssue

                    Input parameter(s):

                    Parameter Is Mandatory Help Text
                    Url true Jira instance Url. Ex – http://localhost:8080
                    Username true Jira login username.
                    Password true Jira login password.
                    Project true Jira projects of the given instance.
                    Entity true Jira issue type of the selected project.
                    Field true Jira fields of the selected issue type.
                    EntityId true Jira Issue Id of the current issue.

                    Output parameter(s):

                    Parameter Help Text
                    IssueId Id of the issue created
                    JiraStatus Final UpdateIssue job status.

                    Pass/Fail Condition:

                    Status Condition
                    Passed If the Issue in jira successfully get updated and no error occurs in fetching/pushing data from jira.
                    Failed If the Issue in jira failed to update or any error occurs in feching/pushing data from jira.
                    1. AddComment

                    Input parameter(s):

                    Parameter Is Mandatory Help Text
                    Url true Jira instance Url. Ex – http://localhost:8080
                    Username true Jira login username.
                    Password true Jira login password.
                    Project true Jira projects of the given instance.
                    Entity true Jira issue type of the selected project.
                    Field true Jira fields of the selected issue type.
                    EntityId true Jira Issue Id in which comment will be pushed.
                    Note : Only comment field will be available for AddComment job.

                    Output parameter(s):

                    Parameter Help Text
                    CommentId Id of the comment added.
                    IssueId Id of the issue created
                    JiraStatus Final AddComment job status.

                    Pass/Fail Condition:

                    Status Condition
                    Passed If the Comment in jira successfully get created and no error occurs in fetching/pushing data from jira.
                    Failed If the Comment in jira failed to create or any error occurs in feching/pushing data from jira.

                    Disclaimers:

                    1. Only ‘Text Field(single and multiline)’ and ‘Select List (Single choice)’ type fields are supported for this plugin.
                    2. Following special characters are supported ~`!@#$%^&*()_+-={}|[]:;<>?,./.
                    3. Multiline text field won’t support any html text as input, wiki and normal text are supported
                    4. User field exposed as singleline text field, provide correct username
                    5. The functionality solely depends on jira API, if the API behaviour changes the result may vary.

                    Release Details:

                    Jira: 1.0.1
                    Initial version with basic functionalities.

                    Contact us:

                      Yes, I accept the Privacy Statement and want to receive latest information from Kovair.

                      [tracking]

                      JFrog Artifactory Plugin Details

                      Plugin Version: 1.0.1
                      Last Update on: December 20, 2019

                      Overview

                      JFrog Artifactory is an artifact repository manager, which is entirely technology agnostic and fully supports software created in any language or using any tool. It is also the only enterprise-ready repository manager available that supports secure, clustered, high availability Docker registries.

                      JFrog Artifactory:

                      More information can be found at JFrog Artifactory.

                      Version Supported:

                      This plugin was developed and tested against version present on JFrog Artifactory 6.13.1

                      Plugin Operation:

                      1. DeployArtifact This operation allows to deploy a file from local computer to JFrog Artifactory repository:

                      Input parameter(s):

                      Parameter Is Mandatory Help Text
                      Url true JFrog Artifactory instance Url(Ex: http://192.168.12.166:8081/artifactory).
                      UserName true JFrog Artifactory login username.
                      Password true JFrog Artifactory login password.
                      Repository true Repository name of JFrog Artifactory (Ex : nuget-local)
                      File Path true Full path of the file to be deployed (Ex : D:\demo\demo.txt)
                      File Name true Name of the file (Ex : deployment.txt)

                      Output parameter(s):

                      Parameter Help Text
                      FileUrl File Url in JFrog Artifactory repository.
                      FileSize File size in byte.
                      CreatedBy File uploaded by.
                      CreatedOn File uploaded on.


                      2. DownloadArtifact This operation allows to download a file from JFrog Artifactory repository to local computer:

                      Input parameter(s):

                      Parameter Is Mandatory Help Text
                      Url true JFrog Artifactory instance Url(Ex: http://192.168.12.166:8081/artifactory).
                      UserName true JFrog Artifactory login username.
                      Password true JFrog Artifactory login password.
                      Repository true Repository name of JFrog Artifactory (Ex : nuget-local)
                      File Name true Name of the file (Ex : deployment.txt)
                      File Path true Full path where the file will be downloaded (Ex : D:\demo\demo.txt)

                      Output parameter(s):

                      Parameter Help Text
                      FilePath File location where the file is downloaded.
                      FileSize File size in byte.

                      Disclaimers:

                      1. Only deploy and download artifact can be done using this plugin.
                      2. For upload and download artifact, file path should be a valid path of agent machine.

                      Release Details:

                      JFrog Artifactory: 1.0.1
                      Initial version with basic functionalities.

                      Contact us:

                        Yes, I accept the Privacy Statement and want to receive latest information from Kovair.

                        [tracking]