Disable LP048 for ARDUINO_LINT_LIBRARY_MANAGER_INDEXING mode

per1234 · per1234 · commit 809540af749f · 2021-05-19T03:45:38.000-07:00
This rule checks for the presence of the library's library.properties `depends` items in the library index. Since the
library index is not available when in `ARDUINO_LINT_LIBRARY_MANAGER_INDEXING` mode, this rule can not run.
diff --git a/internal/rule/ruleconfiguration/ruleconfiguration.go b/internal/rule/ruleconfiguration/ruleconfiguration.go
@@ -1010,7 +1010,7 @@ var configurations = []Type{
 		Brief:            "depends not in index",
 		Description:      "This field should be used to define the dependencies available from Library Manager. Library names are case-sensitive.",
 		MessageTemplate:  "library.properties depends field item(s) {{.}} not found in the Library Manager index.",
-		DisableModes:     nil,
+		DisableModes:     []rulemode.Type{rulemode.LibraryManagerIndexing},
 		EnableModes:      []rulemode.Type{rulemode.Default},
 		InfoModes:        nil,
 		WarningModes:     []rulemode.Type{rulemode.Default},
diff --git a/test/test_all.py b/test/test_all.py
@@ -97,13 +97,13 @@ def test_library_manager_invalid(run_command):
 
 def test_library_manager_indexing(run_command):
     result = run_command(
-        cmd=[test_data_path.joinpath("library-manager", "Update")],
+        cmd=[test_data_path.joinpath("library-manager", "ARDUINO_LINT_LIBRARY_MANAGER_INDEXING", "Servo")],
         custom_env={"ARDUINO_LINT_LIBRARY_MANAGER_INDEXING": "true"},
     )
     assert result.ok
 
     result = run_command(
-        cmd=[test_data_path.joinpath("library-manager", "Update")],
+        cmd=[test_data_path.joinpath("library-manager", "ARDUINO_LINT_LIBRARY_MANAGER_INDEXING", "Servo")],
         custom_env={"ARDUINO_LINT_LIBRARY_MANAGER_INDEXING": "foo"},
     )
     assert not result.ok
diff --git a/test/testdata/library-manager/ARDUINO_LINT_LIBRARY_MANAGER_INDEXING/Servo/Servo.h b/test/testdata/library-manager/ARDUINO_LINT_LIBRARY_MANAGER_INDEXING/Servo/Servo.h
diff --git a/test/testdata/library-manager/ARDUINO_LINT_LIBRARY_MANAGER_INDEXING/Servo/library.properties b/test/testdata/library-manager/ARDUINO_LINT_LIBRARY_MANAGER_INDEXING/Servo/library.properties
@@ -0,0 +1,10 @@
+name=Servo
+version=1.1.7
+author=Michael Margolis, Arduino
+maintainer=Arduino <info@arduino.cc>
+sentence=Allows Arduino/Genuino boards to control a variety of servo motors.
+paragraph=This library can control a great number of servos.<br />It makes careful use of timers: the library can control 12 servos using only 1 timer.<br />On the Arduino Due you can control up to 60 servos.<br />
+category=Device Control
+url=http://www.arduino.cc/en/Reference/Servo
+architectures=avr,megaavr,sam,samd,nrf52,stm32f4,mbed
+depends=Arduino_nonexistent

Original file line number	Diff line number	Diff line change
`@@ -97,13 +97,13 @@ def test_library_manager_invalid(run_command):`
`97`	`97`
`98`	`98`	`def test_library_manager_indexing(run_command):`
`99`	`99`	`result = run_command(`
`100`		`- cmd=[test_data_path.joinpath("library-manager", "Update")],`
	`100`	`+ cmd=[test_data_path.joinpath("library-manager", "ARDUINO_LINT_LIBRARY_MANAGER_INDEXING", "Servo")],`
`101`	`101`	`custom_env={"ARDUINO_LINT_LIBRARY_MANAGER_INDEXING": "true"},`
`102`	`102`	`)`
`103`	`103`	`assert result.ok`
`104`	`104`
`105`	`105`	`result = run_command(`
`106`		`- cmd=[test_data_path.joinpath("library-manager", "Update")],`
	`106`	`+ cmd=[test_data_path.joinpath("library-manager", "ARDUINO_LINT_LIBRARY_MANAGER_INDEXING", "Servo")],`
`107`	`107`	`custom_env={"ARDUINO_LINT_LIBRARY_MANAGER_INDEXING": "foo"},`
`108`	`108`	`)`
`109`	`109`	`assert not result.ok`