Skip to content

Commit

Permalink
GD-322: lint on src/asserts
Browse files Browse the repository at this point in the history
fix lint errors
  • Loading branch information
Mike Schulze committed Jan 23, 2024
1 parent 0d81dfe commit a69b1cf
Show file tree
Hide file tree
Showing 25 changed files with 437 additions and 361 deletions.
36 changes: 18 additions & 18 deletions .gdlintrc
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
class-definitions-order:
- tools
- classnames
- extends
- docstrings
- signals
- enums
- consts
- exports
- pubvars
- prvvars
- onreadypubvars
- onreadyprvvars
- staticvars
- others
- tools
- classnames
- extends
- docstrings
- signals
- enums
- consts
- exports
- pubvars
- prvvars
- onreadypubvars
- onreadyprvvars
- staticvars
- others
class-load-variable-name: (([A-Z][a-z0-9]*)+|_?[a-z][a-z0-9]*(_[a-z0-9]+)*)
class-name: ([A-Z][a-z0-9]*)+
class-variable-name: _?[a-z][a-z0-9]*(_[a-z0-9]+)*
comparison-with-itself: null
constant-name: _?[A-Z][A-Z0-9]*(_[A-Z0-9]+)*
disable: []
duplicated-load: null
enum-element-name: '[A-Z][A-Z0-9]*(_[A-Z0-9]+)*'
enum-element-name: "[A-Z][A-Z0-9]*(_[A-Z0-9]+)*"
enum-name: ([A-Z][a-z0-9]*)+
excluded_directories: !!set
.git: null
Expand All @@ -29,18 +29,18 @@ function-argument-name: _?[a-z][a-z0-9]*(_[a-z0-9]+)*
function-arguments-number: 10
function-name: (_on_([A-Z][a-z0-9]*)+(_[a-z0-9]+)*|_?[a-z][a-z0-9]*(_[a-z0-9]+)*)
function-preload-variable-name: ([A-Z][a-z0-9]*)+
function-variable-name: '[a-z][a-z0-9]*(_[a-z0-9]+)*'
function-variable-name: "[a-z][a-z0-9]*(_[a-z0-9]+)*"
load-constant-name: (([A-Z][a-z0-9]*)+|_?[A-Z][A-Z0-9]*(_[A-Z0-9]+)*)
loop-variable-name: _?[a-z][a-z0-9]*(_[a-z0-9]+)*
max-file-lines: 1000
max-line-length: 140
max-public-methods: 20
max-public-methods: 40
max-returns: 6
mixed-tabs-and-spaces: null
no-elif-return: null
no-else-return: null
private-method-call: null
signal-name: '[a-z][a-z0-9]*(_[a-z0-9]+)*'
signal-name: "[a-z][a-z0-9]*(_[a-z0-9]+)*"
sub-class-name: _?([A-Z][a-z0-9]*)+
tab-characters: 1
trailing-whitespace: null
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/gdlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,13 @@ on:
os:
required: false
type: string
default: 'ubuntu-22.04'
default: "ubuntu-22.04"
workflow_dispatch:
inputs:
os:
required: false
type: string
default: 'ubuntu-22.04'

default: "ubuntu-22.04"

jobs:
gdlint:
Expand All @@ -37,6 +36,7 @@ jobs:
run: |
mkdir -p reports/gdlint/
gdlint addons/gdUnit4/bin/ | tee reports/gdlint/gdlint.txt
gdlint addons/gdUnit4/src/asserts | tee reports/gdlint/gdlint_asserts.txt
- name: Upload GDLint Report
if: failure()
Expand Down
27 changes: 0 additions & 27 deletions addons/gdUnit4/src/GdUnitAssert.gd
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,6 @@ class_name GdUnitAssert
extends RefCounted


# Scans the current stack trace for the root cause to extract the line number
static func _get_line_number() -> int:
var stack_trace := get_stack()
if stack_trace == null or stack_trace.is_empty():
return -1
for index in stack_trace.size():
var stack_info :Dictionary = stack_trace[index]
var function :String = stack_info.get("function")
# we catch helper asserts to skip over to return the correct line number
if function.begins_with("assert_"):
continue
if function.begins_with("test_"):
return stack_info.get("line")
var source :String = stack_info.get("source")
if source.is_empty() \
or source.begins_with("user://") \
or source.ends_with("GdUnitAssert.gd") \
or source.ends_with("AssertImpl.gd") \
or source.ends_with("GdUnitTestSuite.gd") \
or source.ends_with("GdUnitSceneRunnerImpl.gd") \
or source.ends_with("GdUnitObjectInteractions.gd") \
or source.ends_with("GdUnitAwaiter.gd"):
continue
return stack_info.get("line")
return -1


## Verifies that the current value is null.
func is_null():
return self
Expand Down
4 changes: 2 additions & 2 deletions addons/gdUnit4/src/GdUnitAwaiter.gd
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const GdUnitAssertImpl = preload("res://addons/gdUnit4/src/asserts/GdUnitAssertI
# timeout: the timeout in ms, default is set to 2000ms
func await_signal_on(source :Object, signal_name :String, args :Array = [], timeout_millis :int = 2000) -> Variant:
# fail fast if the given source instance invalid
var line_number := GdUnitAssert._get_line_number()
var line_number := GdUnitAssertions.get_line_number()
if not is_instance_valid(source):
GdUnitAssertImpl.new(signal_name)\
.report_error(GdAssertMessages.error_await_signal_on_invalid_instance(source, signal_name, args), line_number)
Expand All @@ -35,7 +35,7 @@ func await_signal_on(source :Object, signal_name :String, args :Array = [], time
# args: the expected signal arguments as an array
# timeout: the timeout in ms, default is set to 2000ms
func await_signal_idle_frames(source :Object, signal_name :String, args :Array = [], timeout_millis :int = 2000) -> Variant:
var line_number := GdUnitAssert._get_line_number()
var line_number := GdUnitAssertions.get_line_number()
# fail fast if the given source instance invalid
if not is_instance_valid(source):
GdUnitAssertImpl.new(signal_name)\
Expand Down
2 changes: 1 addition & 1 deletion addons/gdUnit4/src/asserts/CallBackValueProvider.gd
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# a value provider unsing a callback to get `next` value from a certain function
class_name CallBackValueProvider
class_name CallBackValueProvider
extends ValueProvider

var _cb :Callable
Expand Down
5 changes: 3 additions & 2 deletions addons/gdUnit4/src/asserts/DefaultValueProvider.gd
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# default value provider, simple returns the initial value
class_name DefaultValueProvider
class_name DefaultValueProvider
extends ValueProvider

var _value

func _init(value):
_value = value



func get_value():
return _value
Loading

0 comments on commit a69b1cf

Please sign in to comment.