Skip to content

Commit

Permalink
Add linter
Browse files Browse the repository at this point in the history
  • Loading branch information
juztas committed Dec 11, 2023
1 parent 60deeca commit 0a21656
Show file tree
Hide file tree
Showing 8 changed files with 836 additions and 1 deletion.
9 changes: 9 additions & 0 deletions .deepsource.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
version = 1

[[analyzers]]
name = "python"
enabled = true

[analyzers.meta]
runtime_version = "3.x.x"
max_line_length = 120
72 changes: 72 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"

on:
push:
branches: [ "master" ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ "master" ]
schedule:
- cron: '42 10 * * 1'

jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write

strategy:
fail-fast: false
matrix:
language: [ 'python' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support

steps:
- name: Checkout repository
uses: actions/checkout@v3

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.

# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality


# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v2

# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun

# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.

# - run: |
# echo "Run, Build Application using script"
# ./location_of_script_within_repo/buildscript.sh

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
101 changes: 101 additions & 0 deletions .github/workflows/linter.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
name: Linter

on:
push:
branches: [ "master" ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ "master" ]
schedule:
- cron: '20 10 * * 1'

jobs:
linter:
runs-on: ubuntu-latest
permissions:
actions: write
checks: write
contents: write
deployments: write
id-token: write
issues: write
discussions: write
packages: write
pages: write
pull-requests: write
repository-projects: write
security-events: write
statuses: write
steps:
- name: Checkout
id: checkout
uses: actions/checkout@v4

- name: Run Linter on modified file(s)
id: mainRun
uses: super-linter/super-linter@v5
env:
VALIDATE_ALL_CODEBASE: false
DEFAULT_BRANCH: master
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Remove OK Label if failure
id: remove-ok-label
uses: actions/github-script@v6
if: always() && steps.mainRun.outcome == 'failure'
continue-on-error: true
with:
script: |
github.rest.issues.removeLabel({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
name: ["[ACTION] Linter OK"]
})
- name: Add Failure Label if failure
id: add-fail-label
uses: actions/github-script@v6
if: always() && steps.mainRun.outcome == 'failure'
with:
script: |
github.rest.issues.addLabels({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
labels: ["[ACTION] Linter Failed"]
})
- name: Remove Failed Label if (success or skipped)
id: remove-fail-label
uses: actions/github-script@v6
if: always() && (steps.mainRun.outcome == 'success' || steps.mainRun.outcome == 'skipped')
continue-on-error: true
with:
script: |
github.rest.issues.removeLabel({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
name: ["[ACTION] Linter Failed"]
})
- name: Add OK Label if (success or skipped)
id: add-ok-label
uses: actions/github-script@v6
if: always() && (steps.mainRun.outcome == 'success' || steps.mainRun.outcome == 'skipped')
with:
script: |
github.rest.issues.addLabels({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
labels: ["[ACTION] Linter OK"]
})
- name: Dump steps context
id: dump-env
if: always()
env:
STEPS_CONTEXT: ${{ toJson(steps) }}
run: echo "$STEPS_CONTEXT"
2 changes: 1 addition & 1 deletion export-env.sh
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# This is needed for development and ansible-test
cd ../../../ && export PYTHONPATH=`pwd`:$PYTHONPATH
cd ../../../ && export PYTHONPATH=`pwd`:$PYTHONPATH && cd -
1 change: 1 addition & 0 deletions install.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ansible-galaxy collection install . --force
20 changes: 20 additions & 0 deletions linter.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#!/bin/bash
for fname in $(git diff --name-only HEAD HEAD~1); do
if [[ $fname == *.py ]]
then
echo "Checking $fname with python linters"
black "$fname"
isort "$fname"
pylint "$fname" --rcfile standarts/pylintrc
fi
if [[ $fname == *.yaml || $fname == *.yml ]]
then
echo "Checking $fname with yaml linters"
yamllint "$fname"
fi
if [[ $fname == *.sh ]]
then
echo "Checking $fname with bash linter"
bashlint "$fname"
fi
done
46 changes: 46 additions & 0 deletions plugins/module_utils/runwrapper.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# -*- coding: utf-8 -*-
"""wrapper to log runtimes.
Copyright: Contributors to the SENSE Project
GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
Title : sdn-sense/dellos9
Author : Justas Balcas
Email : juztas (at) gmail.com
@Copyright : General Public License v3.0+
Date : 2023/11/05
"""
import time

from ansible.utils.display import Display

display = Display()


def functionwrapper(func):
"""Function wrapper to print start/runtime/end"""
def wrapper(*args, **kwargs):
if display.verbosity > 5:
display.vvvvvv(
f"[WRAPPER][{time.time()}] Enter {func.__qualname__}, {func.__code__.co_filename}"
)
start_time = time.perf_counter()
result = func(*args, **kwargs)
end_time = time.perf_counter()
total_time = end_time - start_time
display.vvvvvv(
f"[WRAPPER][{time.time()}] Function {func.__qualname__} {args} {kwargs} Took {total_time:.4f} seconds"
)
display.vvvvvv(f"[WRAPPER][{time.time()}] Leave {func.__qualname__}")
else:
result = func(*args, **kwargs)
return result

return wrapper


def classwrapper(cls):
"""Class wrapper to print all functions start/runtime/end"""
for name, method in cls.__dict__.items():
if callable(method) and name != "__init__":
setattr(cls, name, functionwrapper(method))
return cls
Loading

0 comments on commit 0a21656

Please sign in to comment.