Add iOs Swift example and fix missing remote_coverage_tools in main MODULE.bazel (#30)

Author: adincebic

.gitignore

@@ -2,3 +2,4 @@
 .idea/
 *.iml
 bazel-*
+.DS_Store

MODULE.bazel

@@ -1,11 +1,11 @@
 module(
     name = "bazel_sonarqube",
-    version = "1.0.1",
+    version = "1.0.2",
     compatibility_level = 1,
     repo_name = "bazel_sonarqube",
 )
 
-bazel_dep(name = "bazel_skylib", version = "1.0.3", repo_name = "bazel_skylib")
+bazel_dep(name = "bazel_skylib", version = "1.6.1", repo_name = "bazel_skylib")
 
 bazel_dep(
     name = "stardoc",
@@ -15,4 +15,7 @@ bazel_dep(
 )
 
 non_module_dependencies = use_extension("//:extensions.bzl", "non_module_dependencies")
-use_repo(non_module_dependencies, "bazel_version", "org_sonarsource_scanner_cli_sonar_scanner_cli")
+use_repo(non_module_dependencies, "bazel_version", "org_sonarsource_scanner_cli_sonar_scanner_cli")
+
+remote_coverage_tools_extension = use_extension("@bazel_tools//tools/test:extensions.bzl", "remote_coverage_tools_extension")
+use_repo(remote_coverage_tools_extension, "remote_coverage_tools")

examples/README.md

@@ -29,3 +29,7 @@ The usage pattern is similar to the single case except it limits the scope of th
 
 1. `bazel coverage //subproject-with-separate-sonarqube/...`
 2. `bazel run //subproject-with-separate-sonarqube:sonarqube`
+
+# Example integrating bazel_sonarqube with bzlmod
+
+There is also a very simple iOS app example written in swift which demonstrates how to use bazel_sonarqube with [bzlmod](https://docs.bazel.build/versions/5.1.0/bzlmod.html).

examples/swift/.bazelignore

@@ -0,0 +1 @@
+.git

examples/swift/.bazelrc

@@ -0,0 +1,41 @@
+# Enable Bzlmod for every Bazel command
+common --enable_bzlmod
+
+## BUILD
+
+# https://bazel.build/reference/command-line-reference#flag--incompatible_strict_action_env
+build --incompatible_strict_action_env
+
+# Disable the worker, which has sandboxing disabled by default, which can hide
+# issues with non-hermetic bugs.
+build --spawn_strategy=sandboxed,local
+build --worker_sandboxing=true
+
+#build --incompatible_disallow_empty_glob
+
+build --features=swift.use_global_module_cache
+
+# Enable indexing while building.
+build --features swift.use_global_index_store
+build --features swift.index_while_building
+
+## TEST
+
+# `bazel test` tries to build everything also by default, so skip that so the
+# *_library targets in examples/... aren't built (and fail since they are
+# platform specific).
+test --build_tests_only
+
+# Show detailed errors for test failures
+test --test_output=errors
+
+# We only want source files in test coverage reports, not tests themselves.
+test --instrumentation_filter="^//modules/API:APILib"
+
+# Use llvm-cov instead of gcov (default).
+coverage --experimental_use_llvm_covmap
+coverage --collect_code_coverage
+coverage --combined_report=lcov
+coverage --coverage_report_generator=@bazel_sonarqube//:sonarqube_coverage_generator
+# Work around the Bazel issue with paths that contain whitespaces.
+coverage --experimental_inprocess_symlink_creation

examples/swift/.bazelversion

@@ -0,0 +1 @@
+7.1.2

examples/swift/BUILD.bazel

@@ -0,0 +1,79 @@
+load("@bazel_sonarqube//:defs.bzl", "sonarqube")
+
+# Generating Sonar coverage report
+filegroup(
+    name = "test_reports",
+    srcs = glob(["bazel-testlogs/**/test.xml"], allow_empty = True),
+    tags = ["manual"],
+)
+
+filegroup(
+    name = "coverage_report",
+    srcs = ["bazel-out/_coverage/_coverage_report.dat"],
+    tags = ["manual"],
+)
+
+filegroup(
+    name = "git",
+    srcs = glob([".git/**"], exclude = [".git/**/*[*]"]),
+    tags = ["manial"],
+)
+
+sonarqube(
+    name = "sq",
+    srcs = ["//modules/API:sources"],
+    project_key = "your_sonar_project_key",
+    project_name = "Bazel-SwiftUI-template",
+    test_srcs = ["//modules/API:testSources"],
+    test_targets = ["//modules/API:APITestsLib"],
+    sq_properties_template = "sonar-project.properties.tpl",
+    test_reports = [":test_reports"],
+    coverage_report = ":coverage_report",
+    scm_info = [":git"],
+    testonly = True,
+)
+
+load(
+    "@rules_xcodeproj//xcodeproj:defs.bzl",
+    "top_level_target",
+    "xcodeproj",
+)
+
+# Xcode
+
+xcodeproj(
+    name = "xcodeproj",
+    project_name = "App",
+    top_level_targets = [
+        top_level_target(
+            "//app",
+            target_environments = ["simulator"],
+        ),
+        top_level_target(
+            "//modules/API:APITests",
+            target_environments = ["simulator"],
+        ),
+        top_level_target(
+            "//modules/Models:ModelsTests",
+            target_environments = ["simulator"],
+        ),
+    ],
+)
+
+# tools
+
+genrule(
+    name = "lint",
+    srcs = [],
+    outs = ["lint.sh"],
+    cmd = """
+echo "set -e" > "$@"
+echo "./$(location @buildifier_prebuilt//:buildifier) -lint fix -mode fix -r \\$$BUILD_WORKSPACE_DIRECTORY" >> "$@"
+echo "./$(location @SwiftLint//:swiftlint) --fix \\$$BUILD_WORKSPACE_DIRECTORY" >> "$@"
+""",
+    executable = True,
+    tools = [
+        "@SwiftLint//:swiftlint",
+        "@buildifier_prebuilt//:buildifier",
+    ],
+)

examples/swift/MODULE.bazel

@@ -0,0 +1,35 @@
+bazel_dep(name = "bazel_skylib", version = "1.6.1")
+bazel_dep(name = "rules_xcodeproj", version = "2.3.1")
+bazel_dep(
+    name = "apple_support",
+    version = "1.15.1",
+    repo_name = "build_bazel_apple_support",
+)
+bazel_dep(
+    name = "rules_swift",
+    version = "1.18.0",
+    repo_name = "build_bazel_rules_swift",
+)
+bazel_dep(
+    name = "rules_apple",
+    version = "3.5.1",
+    repo_name = "build_bazel_rules_apple",
+)
+bazel_dep(
+    name = "buildifier_prebuilt",
+    version = "6.3.3",
+    dev_dependency = True,
+)
+
+bazel_dep(
+    name = "bazel_sonarqube",
+    version = "1.0.1",
+    repo_name = "bazel_sonarqube",
+)
+local_path_override(
+    module_name = "bazel_sonarqube",
+    path = "../../",
+)
+
+non_module_dependencies = use_extension("//tools:extensions.bzl", "non_module_dependencies")
+use_repo(non_module_dependencies, "SwiftLint")