Merge pull request #56 from jduigoudev/feature/ESOB006-Torch-Free

[ESOB006] iOS Sobriety - Usage of `AVCaptureDevice#torchMode` or `AVCaptureDevice#setTorchModeOn(level:)` must absolutely be avoided

Author: zippy1978

ios-plugin/RULES.md

@@ -11,7 +11,6 @@ Some rules have been already implemented in the plugin. Table of unimplemented r
 | ESOB002 | Thrifty Geolocation | Swift | |
 | ESOB003 | Motion Sensor Update Rate | Swift | |
 | ESOB004 | Disabled Dark Mode | Xml | Plist scanning |
-| ESOB006 | Torch-free | Swift | |
 | ESOB007 | Animation-free | Swift | |
 
 ### Social

ios-plugin/swift-lang/src/main/java/io/ecocode/ios/swift/checks/sobriety/TorchFreeCheck.java

@@ -0,0 +1,49 @@
+/*
+ * ecoCode iOS plugin - Help the earth, adopt this green plugin for your applications
+ * Copyright © 2022 Green code Initiative (https://www.ecocode.io/)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package io.ecocode.ios.swift.checks.sobriety;
+
+import io.ecocode.ios.swift.RegisterRule;
+import io.ecocode.ios.swift.Swift;
+import io.ecocode.ios.swift.antlr.generated.Swift5Parser;
+import io.ecocode.ios.checks.RuleCheck;
+import org.antlr.v4.runtime.tree.ParseTree;
+
+/**
+ * Check the use of "AVCaptureTorchMode.on", "setTorchModeOn(level: Float)", or "torchMode = .on" and triggers when set to true.
+ */
+@RegisterRule
+public class TorchFreeCheck extends RuleCheck {
+
+    public TorchFreeCheck() {
+        super("ESOB006", Swift.RULES_PATH, Swift.REPOSITORY_KEY);
+    }
+
+    @Override
+    public void apply(ParseTree tree) {
+
+        if (tree instanceof Swift5Parser.ExpressionContext) {
+            Swift5Parser.ExpressionContext id = (Swift5Parser.ExpressionContext) tree;
+            String expressionText = id.getText();
+            if (expressionText.contains("AVCaptureTorchMode.on") ||
+                expressionText.contains("setTorchModeOn") ||
+                expressionText.contains("torchMode=.on")) {
+                this.recordIssue(ruleId, id.getStart().getStartIndex());
+            }
+        }
+    }
+}

ios-plugin/swift-lang/src/main/resources/ESOB006.html

@@ -0,0 +1,11 @@
+<img src="http://www.neomades.com/extern/partage/ecoCode/2sur5_1x.png">
+<p>Turning on the torch mode programmatically must absolutely be avoided because the flashlight is one of the most energy-intensive component.</p>
+<h2>Noncompliant Code Example</h2>
+<pre>
+    AVCaptureTorchMode.on
+</pre>
+<pre>
+    "setTorchModeOn(level: Float)"</pre>
+<pre>
+    "torchMode = .on"
+</pre>

ios-plugin/swift-lang/src/main/resources/ecocode-swift-rules.json

@@ -100,5 +100,22 @@
             "eco-design"
         ],
         "type": "CODE_SMELL"
+    },	
+	{
+        "key": "ESOB006",
+        "name": "Sobriety: Torch Free",
+        "severity": "MAJOR",
+        "description": "Usage of `AVCaptureDevice#torchMode` or `AVCaptureDevice#setTorchModeOn(level:)` must absolutely be avoided. These methods can be used to access the device's flashlight, which can be a potential security risk and should only be used when necessary.",
+        "debt": {
+            "function": "CONSTANT_ISSUE",
+            "offset": "5min"
+        },
+        "tags": [
+          "sobriety",
+          "environment",
+          "ecocode",
+          "eco-design"
+        ],
+        "type": "CODE_SMELL"
     }
 ]

ios-plugin/swift-lang/src/main/resources/ecocode_swift_profile.json

@@ -6,6 +6,7 @@
     "EPOW001",
     "EPOW002",
     "ESOB001",
-    "ESOB005"
+    "ESOB005",
+    "ESOB006"
   ]
 }

ios-plugin/swift-lang/src/test/java/io/ecocode/ios/swift/checks/sobriety/TorchFreeCheckTest.java

@@ -0,0 +1,65 @@
+/*
+ * ecoCode iOS plugin - Help the earth, adopt this green plugin for your applications
+ * Copyright © 2022 Green code Initiative (https://www.ecocode.io/)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package io.ecocode.ios.swift.checks.sobriety;
+
+import io.ecocode.ios.swift.checks.CheckTestHelper;
+import org.junit.Test;
+import org.sonar.api.batch.sensor.internal.SensorContextTester;
+import org.sonar.api.batch.sensor.issue.Issue;
+import org.sonar.api.batch.sensor.issue.IssueLocation;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class TorchFreeCheckTest {
+
+    @Test
+    public void should_detect_torch_on_usage() {
+        assertTorchIssue("checks/sobriety/TorchFree_on_trigger.swift", 12);
+    }
+
+    @Test
+    public void should_detect_torch_typeInference_on_usage() {
+        assertTorchIssue("checks/sobriety/TorchFree_typeInference_on_trigger.swift", 12);
+    }
+
+    @Test
+    public void should_detect_level_torch_usage() {
+        assertTorchIssue("checks/sobriety/TorchFree_level_trigger.swift", 12);
+    }
+
+    @Test
+    public void should_not_detect_torch_usage() {
+        SensorContextTester context = CheckTestHelper.analyzeTestFile("checks/sobriety/TorchFree_no_trigger.swift");
+        assertThat(context.allIssues()).isEmpty();
+    }
+    
+    private void assertTorchIssue(String file, int line) {
+        SensorContextTester context = CheckTestHelper.analyzeTestFile(file);
+        assertThat(context.allIssues()).hasSize(1)
+                .allSatisfy(issue -> {
+                    assertIssue(issue, line);
+                });
+    }
+    
+    private void assertIssue(Issue issue, int line) {
+        assertThat(issue.ruleKey().rule()).isEqualTo("ESOB006");
+        assertThat(issue.ruleKey().repository()).isEqualTo("ecoCode-swift");
+        IssueLocation location = issue.primaryLocation();
+        assertThat(location.textRange().start().line()).isEqualTo(line);
+    }
+}

ios-plugin/swift-lang/src/test/resources/checks/sobriety/TorchFree_level_trigger.swift

@@ -0,0 +1,16 @@
+import Foundation
+import SwiftUI
+import AVFoundation
+
+final class AppDelegate: NSObject, UIApplicationDelegate {
+    func application(
+        _ application: UIApplication,
+        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil
+    ) -> Bool {
+
+        let device = AVCaptureDevice.default(for: AVMediaType.video)
+        device.setTorchModeOn(level: AVCaptureDevice.maxAvailableTorchLevel / 2.0)
+        return true
+    }
+}
+

ios-plugin/swift-lang/src/test/resources/checks/sobriety/TorchFree_no_trigger.swift

@@ -0,0 +1,11 @@
+import Foundation
+import SwiftUI
+
+final class AppDelegate: NSObject, UIApplicationDelegate {
+    func application(
+        _ application: UIApplication,
+        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil
+    ) -> Bool {
+        return true
+    }
+}

ios-plugin/swift-lang/src/test/resources/checks/sobriety/TorchFree_on_trigger.swift

@@ -0,0 +1,16 @@
+import Foundation
+import SwiftUI
+import AVFoundation
+
+final class AppDelegate: NSObject, UIApplicationDelegate {
+    func application(
+        _ application: UIApplication,
+        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil
+    ) -> Bool {
+
+        let device = AVCaptureDevice.default(for: AVMediaType.video)
+        device.torchMode = .on
+   
+        return true
+    }
+}

ios-plugin/swift-lang/src/test/resources/checks/sobriety/TorchFree_typeInference_on_trigger.swift

@@ -0,0 +1,16 @@
+import Foundation
+import SwiftUI
+import AVFoundation
+
+final class AppDelegate: NSObject, UIApplicationDelegate {
+    func application(
+        _ application: UIApplication,
+        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil
+    ) -> Bool {
+
+        let device = AVCaptureDevice.default(for: AVMediaType.video)
+        device.torchMode = AVCaptureTorchMode.on
+   
+        return true
+    }
+}