Overrides

There are several override mechanisms built into Exodus, because even the best heuristics are still just heuristics.

Override files need to be placed in the bazel_migration folder in the root of your repository. These files contain serialized JSONs.

Source File Overrides

Excludes specific source files from migration.

Why

Override the following files:

Structure

File path: bazel_migration/source_files.overrides

File contents:

{
  "mutedFiles": [
    "full/path/to/File.scala",
    "full/path/to/OtherFile.scala"
  ]
}

Note: The above path is the file path in a module, excluding the source directory src/main/java, and can be taken from the Codota error message.

Example

 {
    "mutedFiles": [
      "jvm-with-packageJson/src/main/scala/a.scala",
      "com/wix/services/TeamcityFacadeTest.scala"
    ]
}

Internal Target Overrides

Override many aspects of internal targets.

Why

Change the properties of the generated target.

Structure

File path: bazel_migration/internal_targets.overrides

File contents:

{
  "targetOverrides": [
    {
      "label": "((full-label-of target))",
      attributes...
    }
  ]
}

Required Properties

Optional Attributes

Simplified Example:

{
  "targetOverrides": [
    {
      "label": "//bi-modules/wix-page-view-reporting-testapps/wix-page-view-reporting-bootstrap-testapp/src/it/scala/com/wixpress/bi:bi",
      "testType": "ITE2E",
      "testSize": "large",
      "tags": "ITE2E",
      "additionalJvmFlags": [
        "-Djava.io.tmpdir=/tmp"
      ],
      "additionalDataDeps": [
        "@mongo_default_version//:binary"
      ]
    }
  ]
}

Additional Proto Attributes Example:

For accord and call_scope generators use this example.

Note, you need to escape the content. Use an online escaping tool to assist

{
  "targetOverrides": [
    {
      "label": "//foo/bar/src/main/proto:proto",
      "additionalProtoAttributes": "additional_generators = {\r\n        \"accord\": [\r\n            \"@com_wix_accord_api_2_12//jar\",\r\n            \"@com_wix_accord_core_2_12//jar\"\r\n            ],\r\n        \"call_scope\": [],\r\n    },"
    }
  ]
}

The result will be something like:

wix_scala_proto_library(
  name = "name_scala",
  deps = [":name"],
  visibility = ["//visibility:public"],
  additional_generators = {
    "accord": [
      "@com_wix_accord_api_2_12//jar",
      "@com_wix_accord_core_2_12//jar"
    ],
    "call_scope": [],
  },
)

Third Party Overrides

Third party target dependencies on internal targets.

Why

Structure

File path: bazel_migration/third_party_targets.overrides

File contents:

Map of (third-party groupId:ArtifactId) -> (list of Bazel targets)

{
  "compileTimeOverrides": {
    "<groupId>:<artifactId>": [
      "label1", "label2"
    ]
  },
  "runtimeOverrides": {
    "<groupId>:<artifactId>": [
      "label3","label4"
    ]
  }
}

Notes:

Example:

When migrating wix-framework we found dependency on wix-petri which had dependency on koboshi (which is built inside framework).

This is the overrides file:

{
  "compileTimeOverrides": {
    "com.wixpress.common:wix-petri-testkit": [
      "//koboshi-modules/wix-koboshi-testkit/src/main/java/com/wixpress/framework/koboshi/it:it",
      "//test-infrastructures-modules/legacy-java-http-client/src/main/java/com/wixpress/framework/test/apiClient:apiClient",
      "//configuration-modules/hoopoe-config-testkit/src/main/scala/com/wixpress/hoopoe/config:config"
    ],
    "com.wixpress.common:wix-petri-integration": [
      "//koboshi-modules/wix-koboshi/src/main/java/com/wixpress/framework/koboshi/spring/mvc:mvc"
    ]
  }
}

Internal File Dependency Overrides

Add dependencies between internal files.

Why

Structure

File path: bazel_migration/internal_file_deps.overrides

File contents:

Map of (relative path to module ) -> (map of (relative path of using code in module) -> list (relative path of dependency))

{
  "runtimeOverrides" : {
    "relative-path/to/module1" : {
      "src/main/java/path1/file1.java" : [ "relative-path/to/module1/src/main/scala/path/to/dependency/runtime1.scala"],
      "src/main/scala/path2/file2.java" : [ "other/module/src/main/scala/path/to/dependency/runtime2.scala"]
    },
    "relative-path/to/module2" : {
      "src/test/scala/path1/file1.java" : [ "other/module/src/main/scala/path/to/dependency/runtime1.scala"]
    }
  },
  "compileTimeOverrides" : {
    "relative-path/to/module1" : {
      "src/main/scala/path1/file1.java" : [ "other/module/src/main/scala/path/to/dependency/compile1.scala"]
    }
  }
}

Note: For dependencies you should always provide the full path relative to the repo root.

WORKSPACE Overrides

Add non-default repository rule targets at the end of the WORKSPACE file.

Why

Note: Before using this override, please contact us so we’ll make sure the use-case is indeed specific. If it’s generic we want to add it to everyone’s WORKSPACE.

Structure

File path: bazel_migration/workspace.suffix.overrides

Example:

Depending on bazelbuild/bazel-integration-testing repository:

build_bazel_integration_testing_version="36ffe6fe0f4bb727c1fe34209a8d6fd33d8d0d8e" # update this as needed

http_archive(
  name = "build_bazel_integration_testing",
  url = "https://github.com/bazelbuild/bazel-integration-testing/archive/%s.zip" % build_bazel_integration_testing_version,
  strip_prefix = "bazel-integration-testing-%s" % build_bazel_integration_testing_version,
)