Repo improvements (#18)

Enable Superlinter
Restore Pipfile
New badges style
Install pre-commit
Use Taskfile instead of make
Fix broken FOR loop in atests

Author: okgolove

.github/workflows/linter.yml

@@ -0,0 +1,24 @@
+name: Lint Code Base
+
+on:
+  push:
+    branches-ignore: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    name: Lint Code Base
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Lint Code Base
+        uses: github/super-linter@v3
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          DEFAULT_BRANCH: master
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -104,5 +104,5 @@ log.html
 output.xml
 report.html
 
-Pipfile
-Pipfile.lock
+# VSCode repo level settings
+.vscode

.pre-commit-config.yaml

@@ -0,0 +1,47 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-docstring-first
+      - id: debug-statements
+      - id: name-tests-test
+      - id: double-quote-string-fixer
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.4
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          - flake8-typing-imports==1.10.0
+  - repo: https://github.com/pre-commit/mirrors-autopep8
+    rev: v1.5.4
+    hooks:
+      - id: autopep8
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.10.0
+    hooks:
+      - id: pyupgrade
+        args:
+          - '--py36-plus'
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v2.4.0
+    hooks:
+      - id: reorder-python-imports
+        args:
+          - '--py3-plus'
+  - repo: https://github.com/asottile/add-trailing-comma
+    rev: v2.1.0
+    hooks:
+      - id: add-trailing-comma
+        args:
+          - '--py36-plus'
+  # - repo: https://github.com/asottile/setup-cfg-fmt
+  #   rev: v1.16.0
+  #   hooks:
+  #     - id: setup-cfg-fmt
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.812
+    hooks:
+      - id: mypy

Makefile

@@ -0,0 +1,13 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+robotframework-jenkins = {editable = true, path = "."}
+
+[dev-packages]
+autopep8 = "*"
+
+[requires]
+python_version = "3.9"

Pipfile

@@ -1,9 +1,9 @@
-[![PyPI version](https://badge.fury.io/py/robotframework-jenkins.svg)](https://badge.fury.io/py/robotframework-jenkins)
-![Supported Jenkins Version](https://img.shields.io/badge/Tested%20with%20jenkins-%3E2.176.1%20%3C2.234-blue)
-
 JenkinsLibrary for Robot Framework
 ==============================
 
+![PyPI](https://img.shields.io/pypi/v/robotframework-jenkins?style=for-the-badge&color=green)
+![Supported Jenkins Version](https://img.shields.io/badge/Tested%20with%20Jenkins-%3E2.176.1%20%3C2.234-blue?style=for-the-badge)
+
 Introduction
 ------------
 
@@ -38,4 +38,3 @@ Example
         [Setup]    Set Jenkins Server    url=http://example.com:8080    username=admin    password=admin
         Create Jenkins Job    test_job
         Start Jenkins Job    test_job
-

Pipfile.lock

@@ -0,0 +1,29 @@
+version: '3'
+
+tasks:
+  build:
+    cmds:
+      - python setup.py sdist bdist_wheel --universal
+
+  publish:
+    cmds:
+      - twine upload dist/*
+
+  test:docker:rf:
+    cmds:
+      - task: jenkins:docker:run
+      - task: test:rf
+      - task: jenkins:docker:stop
+
+  test:rf:
+    cmds:
+      - robot --loglevel DEBUG --pythonpath src/ atest/
+
+  jenkins:docker:run:
+    cmds:
+      - docker build --pull -t jenkins-robotframework-test atest/docker
+      - docker run --rm --name jenkins-robotframework-test -p 127.0.0.1:8080:8080 -e JAVA_OPTS=-Djenkins.install.runSetupWizard=false -d jenkins-robotframework-test
+
+  jenkins:docker:stop:
+    cmds:
+      - docker stop jenkins-robotframework-test

README.md

@@ -28,7 +28,7 @@ Get Builds (existent jobs, no builds)
     Should Not Be True    ${builds['lastBuild']}
     Should Be Equal As Integers    1    ${builds['nextBuildNumber']}
 
-Check Finished Build Status 
+Check Finished Build Status
     [Tags]    job    build
     [Setup]    Create Job From Template    ${test_job_name}    ${job_sleep}
     [Teardown]    Delete Jenkins Job    ${test_job_name}
@@ -37,12 +37,12 @@ Check Finished Build Status
     ${build_finished} =    Is Build Finished    ${test_job_name}    ${build_number}
     Should Not Be True    ${build_finished}
 
-Check Running Build Status 
+Check Running Build Status
     [Tags]    job    build
     [Setup]    Create Job From Template    ${test_job_name}    ${job_sleep}
     [Teardown]    Delete Jenkins Job    ${test_job_name}
     ${build_number} =    Start Jenkins Job    ${test_job_name}
-    Wait Until Build Starts    ${test_job_name}    ${build_number}    60 sec 
+    Wait Until Build Starts    ${test_job_name}    ${build_number}    60 sec
     Wait Until Build Finishes    ${test_job_name}    ${build_number}
     ${build_finished} =    Is Build Finished    ${test_job_name}    ${build_number}
     Should Be True    ${build_finished}
@@ -52,10 +52,11 @@ Get Next Build Number
     [Setup]    Create Jenkins Job    ${test_job_name}
     [Teardown]    Delete Jenkins Job    ${test_job_name}
     ${random_int} =    Evaluate    random.randint(2, 10)    modules=random
-    :FOR    ${run}    IN RANGE    ${random_int}
-    \    ${next_build_before} =    Get Next Build Number    ${test_job_name}
-    \    Should Be Equal As Integers    ${run + 1}    ${next_build_before}
-    \    ${build_number} =    Start Jenkins Job    ${test_job_name}
-    \    Wait Until Build Finishes    ${test_job_name}    ${build_number}
-    \    ${next_build_after} =    Get Next Build Number    ${test_job_name}
-    \    Should Be Equal As Integers    ${run + 2}    ${next_build_after}
+    FOR    ${run}    IN RANGE    ${random_int}
+        ${next_build_before} =    Get Next Build Number    ${test_job_name}
+        Should Be Equal As Integers    ${run + 1}    ${next_build_before}
+        ${build_number} =    Start Jenkins Job    ${test_job_name}
+        Wait Until Build Finishes    ${test_job_name}    ${build_number}
+        ${next_build_after} =    Get Next Build Number    ${test_job_name}
+        Should Be Equal As Integers    ${run + 2}    ${next_build_after}
+    END

Taskfile.yml

@@ -34,9 +34,10 @@ Create Job From Template
 Create Job And Run Multiple Builds
     [Arguments]    ${job_name}    ${count}=2
     Create Jenkins Job    ${job_name}
-    :FOR    ${run}    IN RANGE    ${count}
-    \    ${build_number} =    Start Jenkins Job    ${job_name}
-    \    Wait Until Build Finishes    ${job_name}    ${build_number}
+    FOR    ${run}    IN RANGE    ${count}
+        ${build_number} =    Start Jenkins Job    ${job_name}
+        Wait Until Build Finishes    ${job_name}    ${build_number}
+    END
 
 Check Build Is Finished
     [Arguments]    ${job_name}    ${build_number}
@@ -51,9 +52,9 @@ Check Build Is Started
 Wait Until Build Finishes
     [Arguments]    ${job_name}    ${build_number}   ${timeout}=20 sec  ${period}=2 sec
     Wait Until Keyword Succeeds    ${timeout}    ${period}\
-    ...   Check Build Is Finished   ${test_job_name}    ${build_number} 
+    ...   Check Build Is Finished   ${test_job_name}    ${build_number}
 
 Wait Until Build Starts
     [Arguments]    ${job_name}    ${build_number}   ${timeout}=20 sec  ${period}=2 sec
     Wait Until Keyword Succeeds    ${timeout}    ${period}\
-    ...   Check Build Is Started   ${test_job_name}    ${build_number} 
+    ...   Check Build Is Started   ${test_job_name}    ${build_number}