zec
/
ZcashLightClientKit
mirror of https://github.com/zcash/ZcashLightClientKit.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
ZcashLightClientKit/.swiftlint_tests.yml

164 lines
3.7 KiB
YAML
Raw Permalink Normal View History

[#778] Add swiflint config file only for tests Closes #778 - .swiftlint.yml is now used to lint only the code of the SDK. - .swiftlint_tests.yml is now used to lint only the code of the tests. This config disables rules that were previously disabled in the code in lot of tests.
2023-02-13 03:53:47 -08:00
# This SwiftLint file is based on this great guideline.
# https://github.com/raywenderlich/swift-style-guide
included:
- Tests/
excluded:
- Tests/TestUtils/proto/
- xctemplates/
- Sources/
- ZcashLightClientKitTests/Constants.generated.swift
- build/
- docs/
[#888] Make actor from ZcashRustBackendWelding Closes #888. - `ZcashRustBackend` is actor now. So majority of methods in this actor are now async. - Some methods stayed `static` in `ZcashRustBackend`. It would be hard to pass instance of the `ZcashRustBackend` to the places where these methods are used in static manner. And it would change lot of APIs. But it isn't problem from technical perspective because these methods would be `nonisolated` otherwise. - Methods `lastError()` and `getLastError()` in `ZcashRustBackend` are now private. This makes sure that ther won't be aby race condition between other methods and these two error methods. - All the methods for which was `lastError()` used in code now throw error. So `lastError()` is no longer needed outside of the `ZcashRustBackend`. - There are in the public API related to `DerivationTool`. - `DerivationTool` now requires instance of the `ZcashRustBackend`. And `ZcashRustBackend` isn't public type. So `DerivationTool` doesn't have any public constructor now. It can be created only via `Initializer.makeDerivationTool()` instance method. - `deriveUnifiedSpendingKey()` and `deriveUnifiedFullViewingKey()` in `DerivationTool` are now async. It is because these are using `ZcashRustBackend` inside. `DerivationTool` offers alternative (closure and combine) APIs. But downside is that there is no sync API to dervie spending key or viewing key. - Some methods of the `DerivationTool` are now static. These methods don't use anything that requires instance of the `DerivationTool` inside. [#888] Use Sourcery to generate mocks - I wrote mock for `Synchronizer` manually. And it's tedious and long and boring work. - Now `ZcashRustBackendWelding` is changed a lot so it means `MockRustBackend` must be changed a lot. So I decided to introduce `sourcery` to generate mocks from protocols so we don't have to do it manually ever. - To generate mocks go to `ZcashLightClientKit/Tests/TestUtils/Sourcery` directory and run `generateMocks.sh` script. - Your protocol must be mentioned in `AutoMockable.swift` file. Generated mocks are in `AutoMockable.generated.swift` file. [#888] Fix Offline tests - Offline tests target now runs and tests are green. - There is log of changes in tests. But logic is not changed. - Updated `AutoMockable.stencil` so sourcery is able to generate mock as actor when protocol is marked with: `// sourcery: mockActor`. - Last few updates in `ZcashRustBackendWelding`. In previous PR `rewindCacheToHeight` methods was overlooked and it didn't throw error. - Removed `MockRustBackend` and using generated `ZCashRustBackendWeldingMock` instead. - Using generated `SynchronizerMock`. [#888] Fix NetworkTests - Changed a bit how rust backend mock is used in the tests. Introduced `RustBackendMockHelper`. There are some state variables that must be preserved within one instance of the mock. This helper does exactly this. It keeps this state variables in the memory and helping mock to work as expected. [#888] Fix Darkside tests Create ZcashKeyDeriving internal protocol Use New DerivationTool that does not require RustBackend Remove duplicated methods that had been copied over [#888] Fix potentially broken tests I broke the tests because I moved `testTempDirectory` from each `TestCase` to the `Environment`. By this I caused that each tests uses exactly same URL. Which is directly against purpose of `testTempDirectory`. So now each test calls this one and store it to local variable. So each test has unique URL. [#888] Add ability to mock nonisolated methods to AutoMockable.stencil [#888] Add changelog and fix the documentation in ZcashRustBackendWelding [#888] Rename derivation rust backend protocol and remove static methods - Renamed `ZcashKeyDeriving` to `ZcashKeyDerivationBackendWelding`. So the naming scheme is same as for `ZcashRustBackendWelding`. - `ZcashKeyDerivationBackend` is now struct instead of enum. - Methods in `ZcashKeyDerivationBackendWelding` (except one) are no longer static. Because of this the respective methods in `DerivationTool` aren't also static anymore.
2023-03-31 10:10:35 -07:00
- Tests/TestUtils/Sourcery/GeneratedMocks/AutoMockable.generated.swift
[#778] Add swiflint config file only for tests Closes #778 - .swiftlint.yml is now used to lint only the code of the SDK. - .swiftlint_tests.yml is now used to lint only the code of the tests. This config disables rules that were previously disabled in the code in lot of tests.
2023-02-13 03:53:47 -08:00
disabled_rules:
- notification_center_detachment
- orphaned_doc_comment
- todo
- unused_capture_list
- nesting # allow for types to be nested, common pattern in Swift
- multiple_closures_with_trailing_closure
- generic_type_name # allow for arbitrarily long generic type names
- redundant_void_return
[#801] Improve wipe implementation Closes #801 - `SDKSynchronizer.wipe()` can be now called anytime. - If the sync is in progress then the sync is first stopped and then wipe is executed. - Wipe now returns AnyPublisher which completes or fails when wipe is done. - Majority of wipe's work is to delete files. That is only operation that can throw error during wipe. This operation should succeed every time. If it fails that something is seriously wrong. When this happens the SDK can happen in inconsistent state. There is no recovery for now. Only way how to fix this is to reinstall the app in the device. - Added hooks mechanism. This is implemented in `AfterSyncHooksManager` and it is used by `CompactBlockProcessor`. It's just more organized way how to track what should happen when the sync process is canceled.
2023-02-20 01:53:04 -08:00
- empty_parentheses_with_trailing_closure
[#778] Add swiflint config file only for tests Closes #778 - .swiftlint.yml is now used to lint only the code of the SDK. - .swiftlint_tests.yml is now used to lint only the code of the tests. This config disables rules that were previously disabled in the code in lot of tests.
2023-02-13 03:53:47 -08:00
- implicitly_unwrapped_optional
- force_unwrapping
- type_body_length
- function_body_length
- file_length
- cyclomatic_complexity
- force_cast
- force_try
- function_parameter_count
- identifier_name
opt_in_rules:
- mark
- array_init
- attributes
- closure_end_indentation
- closure_spacing
- collection_alignment
- colon # promote to error
- convenience_type
- discouraged_object_literal
- empty_collection_literal
- empty_count
- empty_string
- enum_case_associated_values_count
- fatal_error_message
- first_where
- indentation_width
- last_where
- legacy_random
- literal_expression_end_indentation
- multiline_arguments
- multiline_arguments_brackets
- multiline_function_chains
- multiline_literal_brackets
- multiline_parameters
- multiline_parameters_brackets
- no_space_in_method_call
- operator_usage_whitespace
- overridden_super_call
- pattern_matching_keywords
- prefer_self_type_over_type_of_self
- redundant_nil_coalescing
- redundant_type_annotation
- return_arrow_whitespace
- strict_fileprivate
- toggle_bool
# - trailing_closure # weird in SwiftUI
- unneeded_parentheses_in_closure_argument
- vertical_whitespace_closing_braces
- vertical_whitespace_opening_braces
- weak_delegate
- yoda_condition
- todos
analyzer_rules:
- unused_import
custom_rules:
array_constructor:
name: "Array/Dictionary initializer"
regex: '[let,var] .+ = (\[.+\]\(\))'
capture_group: 1
message: "Use explicit type annotation when initializing empty arrays and dictionaries"
severity: warning
string_concatenation:
included: ".*\\.swift"
excluded: ".*Test\\.swift"
name: "String Concatenation"
regex: " \\+ \"|\" \\+ |\\+= \""
message: "Please use string interpolation instead of concatenation"
severity: error
nslog_function_usage:
included: ".*\\.swift"
excluded: ".*Test\\.swift"
name: "Swift NSLog() should not be used in App Code"
regex: "NSLog\\("
message: "The swift NSLog function should not be used."
severity: error
todos:
included: ".*\\.swift"
name: "TODO"
regex: '(TODO|FIXME):\ ([^\[]|\[[^#]|\[#[^1-9])'
message: "TODO or FIXME without issue number. Format TODO: [#...]"
severity: warning
match_kinds:
- comment
attributes:
always_on_same_line:
- "@IBSegueAction"
- "@IBAction"
- "@NSManaged"
- "@objc"
legacy_hashing: error
identifier_name:
excluded:
- i
- id
- x
- y
- z
- to
- at
- db
- ua
- nf
- tx
- as
indentation_width:
indentation_width: 4
[#801] Improve wipe implementation Closes #801 - `SDKSynchronizer.wipe()` can be now called anytime. - If the sync is in progress then the sync is first stopped and then wipe is executed. - Wipe now returns AnyPublisher which completes or fails when wipe is done. - Majority of wipe's work is to delete files. That is only operation that can throw error during wipe. This operation should succeed every time. If it fails that something is seriously wrong. When this happens the SDK can happen in inconsistent state. There is no recovery for now. Only way how to fix this is to reinstall the app in the device. - Added hooks mechanism. This is implemented in `AfterSyncHooksManager` and it is used by `CompactBlockProcessor`. It's just more organized way how to track what should happen when the sync process is canceled.
2023-02-20 01:53:04 -08:00
include_comments: false
[#778] Add swiflint config file only for tests Closes #778 - .swiftlint.yml is now used to lint only the code of the SDK. - .swiftlint_tests.yml is now used to lint only the code of the tests. This config disables rules that were previously disabled in the code in lot of tests.
2023-02-13 03:53:47 -08:00
line_length:
warning: 150
ignores_urls: true
ignores_function_declarations: true
ignores_comments: true
multiline_arguments:
first_argument_location: next_line
only_enforce_after_first_closure_on_first_line: true
private_over_fileprivate:
validate_extensions: true
trailing_whitespace:
ignores_empty_lines: true
ignores_comments: true
vertical_whitespace:
max_empty_lines: 1