Saravanan666/pypi-org huggingface dataset:
Package: robotframework-sshlibrary-forwardagent
IntroductionSSHLibrary is aRobot Frameworktest
library for testing SSH and SFTP. It is operating system independent
and works both with Python and Jython.The library has the following main usages:Executing commands on the remote machine, either with blocking or
non-blocking behavior.Writing and reading in an interactive shell.Transferring files and directories over SFTP.Ensuring that files and directories exist on the remote machine.SSHLibrary is open source software licensed underApache License 2.0.InstallationWhen installing SSHLibrary on UNIX-like machines with Python, the easiest
approach is usingpip:pip install robotframework-sshlibraryAlternatively you can download the source distribution fromPyPI, extract
it, and install it using one of the following depending are you using
Python or Jython:python setup.py install
jython setup.py installA benefit of using pip is that it automatically installsparamikoandPyCryptomodules that SSHLibrary requires on Python. Using pip on Windows with
Python works too, but you need to first install PyCrypto module
manually.On Jython SSHLibrary requires Trilead SSH JAR distribution.For more detailed installation instructions seeINSTALL.rst.DocumentationKeyword documentation by version can be found fromhttp://robotframework.org/SSHLibrary/.For general information about using test libraries with Robot Framework, seeRobot Framework User Guide.
Package: robotframework-sshlibrary-py3
IntroductionSSHLibrary is aRobot Frameworktest
library for testing SSH and SFTP. It is operating system independent
and works both with Python and Jython.The library has the following main usages:Executing commands on the remote machine, either with blocking or
non-blocking behavior.Writing and reading in an interactive shell.Transferring files and directories over SFTP.Ensuring that files and directories exist on the remote machine.SSHLibrary is open source software licensed underApache License 2.0.InstallationWhen installing SSHLibrary on UNIX-like machines with Python, the easiest
approach is usingpip:pip install robotframework-sshlibraryAlternatively you can download the source distribution fromPyPI, extract
it, and install it using one of the following depending are you using
Python or Jython:python setup.py install
jython setup.py installA benefit of using pip is that it automatically installsparamikoandPyCryptomodules that SSHLibrary requires on Python. Using pip on Windows with
Python works too, but you need to first install PyCrypto module
manually.On Jython SSHLibrary requires Trilead SSH JAR distribution.For more detailed installation instructions seeINSTALL.rst.DocumentationKeyword documentation by version can be found fromhttp://robotframework.org/SSHLibrary/.For general information about using test libraries with Robot Framework, seeRobot Framework User Guide.
Package: robotframework-sshtunnellibrary
# robotframework-sshtunnellibrarySSHTunnelLibrary is a Robotframework library to support SSHTunnels. It will help to connect to remote host using SSH Local Forwarding.## UsageInstall robotframework-sshtunnellibrary and its dependencies via pip```pip install -U sshtunnelpip install -U robotframework-sshtunnellibrary```## ExampleSSH Tunnel Library can be used with libraries like SSHLibrary, RequestLibrary, DatabaseLibrary, SeleniumLibrary to make connection to ssh, rest api, database connection, web application respectively.Here is an example to make SSH connection using request library via SSH Server.``` robotframework*** Settings ***Library  SSHTunnelLibraryLibrary  SSHLibrary*** Variables ***${REMOTE_HOST}=  <Remote_IP/Name>${REMOTE_PORT}=  22${SSH_SERVER}=  <SSH_Server_IP/Name>${SSH_SERVER_PORT}=  22${SSH_SERVER_USERNAME}=  <SSH_Server_Username>${SSH_SERVER_PASSWORD}=  <SSH_Server_Password>${LOCAL_HOST}=  localhost${LOCAL_PORT}=  0${REMOTE_USERNAME}=  <Remote_host_Username>${REMOTE_PASSWORD}=  <Remote_host_Password>*** Test Cases ***SSH Connection using SSH Tunnel# Create TunnelStart SSH Tunnel  MySshTunnel  ${REMOTE_HOST}  ${REMOTE_PORT}  ${SSH_SERVER}  ${SSH_SERVER_PORT}  ${SSH_SERVER_USERNAME}  ${SSH_SERVER_PASSWORD}  ${LOCAL_HOST}  ${LOCAL_PORT}${LOCAL_BIND_PORT}=  Get Local Port# Connection using local bindOpen Connection     ${LOCAL_HOST}  port=${LOCAL_BIND_PORT}Login               ${REMOTE_USERNAME}        ${REMOTE_PASSWORD}# Closing the TunnelStop SSH Tunnel  MySshTunnel```
Package: robotframework-statemachinelibrary
Author:marcinoooTags:Robot Framework, Python, State Machine, Libraryabstract:Implementation of state machine in robot framework.ContentsDescriptionDocumentationInstallationUsageOverviewLicenseDescriptionLibrary contains implementation of state machine
to control or test software components which can be in many states.DocumentationLibrary documentation can be foundhere.A good starting point is to check examples:basic exampleusage of library in python codeusage of two state machinesInstallationInstall from PyPI:$ pip installrobotframework-statemachinelibraryInstall from github:$ pip installgit+https://github.com/marcinooo/robot-framework-state-machineUsageAn example of using the library for LED blinking (of course, the library was created for more complex tasks :wink:).*** Settings ***LibraryStateMachineLibrary*** Tasks ***Blink[setup]Task SetupRun State Machinestart_from=Turn On Lightmax_updates=10*** Keywords ***Task SetupCreate State Machinename=blink-machineAdd Statestate=Turn On Lighton_update=On Update Turn On LightAdd Statestate=Turn Off Lighton_update=On Update Turn Off LightTurn On LightLog To ConsoleI am ONOn Update Turn On LightSleep0.25sGo To Statestate=Turn Off LightTurn Off LightLog To ConsoleI am OFFOn Update Turn Off LightSleep0.25sGo To Statestate=Turn On LightFlow diagram:OverviewFirst of all import the library:LibraryStateMachineLibraryCreate a state machine:Create State Machinename=blink-machineYou can create as many as you want state machines. Each state machine should have a unique name.Register keywords that should be executed in the given state (Turn On Light) and during its update (On Update Turn On Light):Add Statestate=Turn On Lighton_update=On Update Turn On LightBoth keywords must be defined:*** Keywords ***# ...Turn On Light# Here you can put logic (e.g.: led controller)Log To ConsoleI am ONOn Update Turn On LightGo To Statestate=Turn Off LightKeywordsOn Update…should indicate the next state:Go To Statestate=Turn Off LightCall the same keyword to enter the first state.Force transition to a next state:Update StateYou can pass data between states incontext(recommended method) or using global variables.*** Keywords ***# ...Turn On LightUpdate Contextled_status=ONTurn Off Light# ...&{context}=Get ContextLog To ConsoleLED is${context["led_status"]}Licenselicense(MIT)
Package: robotframework-stringformat
StringFormat is a string formatter for Robot Framework. This library is a python .format() wrapper.Usage*** Settings ***LibraryStringFormat*** Test Cases ***Format Text${url}=Format Stringhttps://api.domain.com/users/{0}/sites/{1}paulinternalLog To Console${url}Outputhttps://api.domain.com/users/paul/sites/internalSupported FormatStringFormat library utilizes python str.format method to construct formatted string. The format spec depends on what version of python this library being executed on. See the following resources for detail.Python 2:https://docs.python.org/2/library/string.html#format-string-syntaxPython 3:https://docs.python.org/3.4/library/string.html#format-string-syntaxLicenseMIT
Package: robotframework-stublibrary
Introductionrobotframework-stublibrary is aRobot Frameworktest library for all your HTTP
needs. It uses:webtestgeventfalconpy_fake_serverlibrary underneath now.InstallationYou can install robotframework-stublibrary viapip:pip install --upgrade robotframework-stublibraryUsagehere is an example on how to use it:https://github.com/ravihuang/robotframework-stublibrary/blob/master/tests/tests.txt,SettingValueLibraryStubLibraryCompatibilityThis library is only tested on CPython. It might work on Jython, not sure.DevelopmentIf you want to hack on this library itself, this should get you started:# install
git clone https://github.com/peritus/robotframework-stublibrary.git
cd robotframework-stublibrary/
python setup.py install

# run tests
pybot tests/I’m very happy about patches, pull-requests and API-discussions (as this is
mostly a wrapper supposed to have a nice API)!Changelogv0.1.3newLicenseApache License
Package: robotframework-suds2library
ContentsIntroductionDocumentationInstallationSupportIntroductionSuds2Library is aRobot Frameworktest library for functional testing of SOAP-based web services.
It is a full Python 3 port ofSudsLibraryusingsuds-py3as a SOAP client.Suds2Library is operating system independent and supports onlyPython3.5 or newer.DocumentationSeekeyword documentationfor available keywords and more information about the library in general.For general information about using test libraries with Robot Framework, seeRobot Framework User Guide.InstallationThe recommended installation method is usingpip:pip install robotframework-suds2libraryRunning this command installs also the latest versions of Robot Framework andsuds-py3.Alternatively you can download the source distribution fromPyPI, extract
it, and install it:python setup.py installSupportThere are various support forums available:robotframework-usersmailing listRobot FrameworkSlack communityRobot FrameworkforumSuds2Libraryissue trackerfor bug reports and concrete enhancement
requests
Package: robotframework-tarantoollibrary
Short DescriptionRobot Frameworklibrary for working with Tarantool DB.Installationpip install robotframework-tarantoollibraryExample*** Settings ***Librarytarantoollibrary*** Test Cases ***${data_from_trnt}=Selectspace_name=some_space_namekey=0key_type=NUMSet Test Variable${key}   ${data_from_trnt[0][0]}Set Test Variable${data_from_field}   ${data_from_trnt[0][1]}*** Settings ***LicenseApache License 2.0
Package: robotframework-templateddata
TemplatedDataIntroductionRequirementsInstallationUsageDefault valuesReturn value typeJinja templatingIntroductionTemplatedData is Robot Framework library for dynamically generated test data using robot variables and Jinja templating.RequirementsPython 3.6+ and Robot Framework 3.2.1+.TemplatedData will most likely work on other versions but it’s not tested on them.InstallationYou can install TemplateData by running:pip install robotframework-templateddataUsageYou need to import TemplatedData as library first:*** Settings ***
Library    TemplatedDataTemplatedData will replace all occurences of robot variables (${var}) in file or variable using current robot context
and scopes. All test data in below examples are saved under ‘test_data.txt’ filesTest data:my variable is ${var}Robot code:${var}     Set Variable    ${10}
${data}    Get Templated Data From Path    test_data.txt
Log    ${data} # it should print `my variable is 10`Default valuesIf the variable is not found it will be replaced with empty string. You can override that behaviour:${data}    Get Templated Data From Path    test_data.txt    default_empty=${5}
Log    ${data} # it should print `my variable is 5`You can also set default value of variable with:symbol.Test data:my variable is ${var} and ${var2:some string}Robot code:${var}     Set Variable    ${10}
${data}    Get Templated Data From Path    test_data.txt
Log    ${data} # it should print `my variable is 10 and some string`Return value typeReturn value can be either text/string (default) or json.Test data:{ "key": "${var}" }Robot code:${data}    Get Templated Data From Path    test_data.txt    var=value    return_type=json
Log    ${data} # it should print `{ "key": "value" }` and ${data} will be of type jsonJinja templatingTemplatedData can also render the Jinja templates using Robot Framework variables. To enable Jinja template passjinja_templateas argument to
library import or method call:*** Settings ***
Library    TemplatedData  jinja_template=${True}

OR

*** Keywords ***
Load Data
    ${data}    Get Templated Data From Path    data.template    jinja_template=${True}Test data (Jinja template):{
    "accounts": [
        { "id": {{ ${account_id:5} }} },
        { "id2": "{{ ${account_id2} }}" }
        ],
    "users": [
{%- for user, amount in ${users.items()} %}
      {
        "name": "{{ user }}",
        "amount": {{ amount }}
      }{{ "," if not loop.last }}
{%- endfor %}
    ]
}Robot code:${data}    Get Templated Data From Path    data.template    jinja_template=${True}Example data output:{
    "accounts": [
        { "id": 10 },
        { "id2": "10" }
        ],
    "users": [
      {
        "name": "bartek",
        "amount": 5
      },
      {
        "name": "tymoteusz",
        "amount": 10
      },
      {
        "name": "pawel",
        "amount": -1
      }
    ]
}
Package: robotframework-testrail
RobotFramework TestrailShort DescriptionRobot Frameworklibrary, listener and pre-run modifier for working with TestRail.Installationpip install robotframework-testrailDocumentationSee documentation onGitHub.UsageHow to enable TestRail APITestRail API ClientLibrary for working withTestRail.Example*** Settings ***
Library    TestRailAPIClient    host    user    password    run_id

*** Test Cases ***
Case
    ${project}=    Get Project    project_id
    ${section}=    Add Section    project_id=${project['id']    name=New Section
    ${case}=       Add Case    ${section['id']}    Title    Steps    Description    Refs    type_id    priority_id
    Update Case    ${case['id']}    request_fieldsTestRail ListenerFixing of testing results and updating test cases.ExampleCreate custom field "case_description" with type "text", which corresponds to the Robot Framework's test case documentation.Create Robot test:*** Test Cases ***
Autotest name
    [Documentation]    Autotest documentation
    [Tags]    testrailid=10    defects=BUG-1, BUG-2    references=REF-3, REF-4
    Fail    Test fail messageRun Robot Framework with listener:pybot --listener TestRailListener.py:testrail_server_name:tester_user_name:tester_user_password:run_id:https:update  robot_suite.robotTest with case_id=10 will be marked as failed in TestRail with message "Test fail message" and defects "BUG-1, BUG-2".Also title, description and references of this test will be updated in TestRail. Parameter "update" is optional.TestRail Pre-run ModifierPre-run modifier for starting test cases from a certain test run.ExampleCreate Robot test:*** Test Cases ***
    Autotest name 1
    [Documentation]    Autotest 1 documentation
    [Tags]    testrailid=10
    Fail    Test fail message
    Autotest name 2
    [Documentation]    Autotest 2 documentation
    [Tags]    testrailid=11
    Fail    Test fail messageRun Robot Framework with pre-run modifier:pybot --prerunmodifier TestRailPreRunModifier:testrail_server_name:tester_user_name:tester_user_password:run_id:http:results_depth robot_suite.robotOnly test cases that are included in the test runrun_idwill be executed.To execute tests from TestRail test run only with a certain status, for example "failed" and "blocked":pybot --prerunmodifier TestRailPreRunModifier:testrail_server_name:tester_user_name:tester_user_password:run_ind:http:results_depth:failed:blocked robot_suite.robotLicenseApache License 2.0
Package: robotframework-testrail-correct-link
RobotFramework Testrail Correct LinkShort DescriptionRobot Frameworklibrary, listener and pre-run modifier for working with TestRail.Installationpip install robotframework-testrail-correct-linkDocumentationSee documentation onGitHub.UsageHow to enable TestRail APITestRail API ClientLibrary for working withTestRail.Example*** Settings ***
Library    TestRailAPIClient    host    user    password    run_id

*** Test Cases ***
Case
    ${project}=    Get Project    project_id
    ${section}=    Add Section    project_id=${project['id']    name=New Section
    ${case}=       Add Case    ${section['id']}    Title    Steps    Description    Refs    type_id    priority_id
    Update Case    ${case['id']}    request_fieldsTestRail ListenerFixing of testing results and updating test cases.ExampleCreate custom field "case_description" with type "text", which corresponds to the Robot Framework's test case documentation.Create Robot test:*** Test Cases ***
Autotest name
    [Documentation]    Autotest documentation
    [Tags]    testrailid=10    defects=BUG-1, BUG-2    references=REF-3, REF-4
    Fail    Test fail messageRun Robot Framework with listener:pybot --listener TestRailListener.py:testrail_server_name:tester_user_name:tester_user_password:run_id:https:update  robot_suite.robotTest with case_id=10 will be marked as failed in TestRail with message "Test fail message" and defects "BUG-1, BUG-2".Also title, description and references of this test will be updated in TestRail. Parameter "update" is optional.TestRail Pre-run ModifierPre-run modifier for starting test cases from a certain test run.ExampleCreate Robot test:*** Test Cases ***
    Autotest name 1
    [Documentation]    Autotest 1 documentation
    [Tags]    testrailid=10
    Fail    Test fail message
    Autotest name 2
    [Documentation]    Autotest 2 documentation
    [Tags]    testrailid=11
    Fail    Test fail messageRun Robot Framework with pre-run modifier:pybot --prerunmodifier TestRailPreRunModifier:testrail_server_name:tester_user_name:tester_user_password:run_id:http:results_depth robot_suite.robotOnly test cases that are included in the test runrun_idwill be executed.To execute tests from TestRail test run only with a certain status, for example "failed" and "blocked":pybot --prerunmodifier TestRailPreRunModifier:testrail_server_name:tester_user_name:tester_user_password:run_ind:http:results_depth:failed:blocked robot_suite.robotLicenseApache License 2.0
Package: robotframework-testrail-library-nerajarolle
robotframework-testrail-libraryThis is a robot framework library to be used with Testrail API.The library requires a Testrail username and API key, which needs to be created in testrail. The credentials are passed to the library with theconnect to testrailkeyword. So library can be imported without credentials, and it will connect only when a keyword is called.Some keywords are trying to find a suite/run... by name, and they assume the name is unique, given some conditions. For example it is assumed that in same project there is only one run with a specific name. This can be overriden by providing a special attribute for the class. Some adding keywords have logic to find a particular run or suite by either id or name, and if name is used and there are duplicates, then either exception is raised (default) or empty dictionary is returned (in case expected duplicates is True), since we cannot be sure which object we are adding stuff.Deleting keywords are currently not supported, for safety reasons, as accidentally deleted wrong objects, may delete hundreds of other related objects, so it is preferrable to delete things manually in Testrail.Installation:pip install robotframework-testrail-library-nerajarolleExample Usage:*** Settings ***
Library   TestrailLibrary  
Suite Setup    connect to testrail    ${SERVER}   
...                 ${TESTRAIL_USERNAME}   ${TESTRAIL_KEY}

*** Test Cases ***
Test Get Project
    [Tags]   project   id
    ${project}   Get Project     1 
    IF  ${project}
        Log To Console  ${project}
    ELSE
        Log To Console    Project id 1 Not found  
    END

Test Get Project by Name
    [Tags]   project  name
    ${project}   Get Project by Name    TA Test Project  
    IF  ${project}
        Log To Console  ${project}
    ELSE
        Log To Console   TA Test Project Not found  
    END

Test Update Run Status 
    [Tags]   update_status
    ${params}   Create Dictionary    project_id=${PROJECT_ID}   run_name=Run number 1  
    ...   suite_name=${SUITE_NAME}   test_name=${TEST_NAME}   section_name=${SUITE_NAME}
    ...   elapsed=20s   comment=a comment   
    ${response}  set status on test run   status_id=1   &{params}  
    IF  ${response}
        log To Console    ${response}
    ELSE 
        log to console    Failed to update run ${response}
    END
Package: robotframework-testrail-reporter
robotframework-testrail-reporterrobotframework-testrail-reporter is a Python library used to publish robotframework test executions to TestRail.
It parses the output.xml file and search tests tagged with a specific testcase id, then it retrieves testcases run id from  TestRailtest suite run id.Installationrobotframework-testrail-reporter requires python3+, lxml, and testrail installed and  to run. (and robotframework to execute tests)$pip3installrobotframework-testrail-reporter
$rf-tr-reporter-foutput.xml-ttest-case-id-uhttps://xxx.testrail.io/-emy@email.com-kpwd_or_apikey-rrunidMethodsMethodArgumentsREADMEfind_tests_tagged_bypath, tagThis method parses the output xml generated by robotframework defined by path and finds all test nodes with starting tag tag.Returns a list of dictionaries with following keys: ['rf_test_name', 'test_id , 'status_id, 'comment', 'elapsed']rf_test_nameis the robotframework test nametest_idis the numeric value contained in tagstatus_idis the conversion of test status to testrail standardscommentis the test status messageelapsedis the test execution time in s, (min 1 second)Args:pathis the path of robotframework xml output filetagis the tag to be found in robotframework tests, it must contain a numeric part which specifies testcase run id, example: test_case_id=123get_commentstatusThis method returns the test execution status message which is the text attribute of teststatusnode in output xml, if no text is found it retuns an empty string. Comment maximum length is defined by comment_size_limit variable.Args:statusis the status node found via xpath selector with lxmlget_elapsedstatusThis method calculates the elapsed test execution time which is endtime - starttime in teststatusnode of output XML. Returns a string of test execution seconds. Example: '5s'Args:statusis the status node found via xpath selector with lxmlpublish_resultsapi, run_id, resultsThis method publishes robotframework results to a testrail runArgs:apiis an instance of testrail.client.API already logged inrun_idis the id of the run to updateresultsis a list of dictionaries that contains test resultsreplace_caseid_with_testidapi, results, run_idThis method parses all results generated by find_tests_tagged_by method and replace all testcases ids with specific testruns ids in test_id key of each resultArgs:apiis an instance of testrail.client.API already logged inresultsis a list of dictionaries that contains test resultsrun_idis the id of the run to update
Package: robotframework-tidy
RobotidyIntroductionDocumentationRequirementsInstallationUsageExampleIntroductionRobotidy is a tool for autoformatting Robot Framework code.It is spiritual descendant of Robot Framework's internal robot.tidy package.DocumentationFull documentation availablehere. :open_book:RequirementsPython 3.7+ :snake: and Robot Framework 4.0.0+ :robot:.InstallationYou can install Robotidy simply by running:pip install -U robotframework-tidyUsageCall robotidy with path(s) to file/directory with robot files:robotidy tests
robotidy test.robot
robotidy tests/resources test.robotAll command line options can be displayed in help message by executing:robotidy --helpSeedocumentationfor information how to configure
robotidy.ExampleUgly code before transforming with robotidy:*** Settings ***Force Tagstagstag2LibraryCollectionsResourceimportant.robotLibraryMyCustomLibrary.pyTest SetupSetup Keyword*** test case*Test1[teardown]Teardown KeywordKeywordFOR${var}IN RANGE10Run Keyword If${var}>5Other KeywordEND*** Variables ***${var}=2${bit_longer}10${var2}a...b*** Keywords ***A lot prettier code after:*** Settings ***LibraryCollectionsLibraryMyCustomLibrary.pyResourceimportant.robotTest SetupSetup KeywordForce Tagstagstag2*** Variables ***${var}2${bit_longer}10${var2}a...b*** Test Cases ***Test1KeywordFOR${var}IN RANGE10IF${var}>5Other KeywordENDEND[Teardown]Teardown Keyword