RustLinkerIntegrationTest.java

/*
 * Copyright 2016-present Facebook, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package com.facebook.buck.rust;

import static org.junit.Assert.assertThat;

import com.facebook.buck.testutil.integration.ProjectWorkspace;
import com.facebook.buck.testutil.integration.TemporaryPaths;
import com.facebook.buck.testutil.integration.TestDataHelper;
import com.facebook.buck.util.HumanReadableException;
import java.io.IOException;
import org.hamcrest.Matchers;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;

public class RustLinkerIntegrationTest {
  @Rule public TemporaryPaths tmp = new TemporaryPaths();

  @Rule public ExpectedException thrown = ExpectedException.none();

  @Before
  public void ensureRustIsAvailable() throws IOException, InterruptedException {
    RustAssumptions.assumeRustCompilerAvailable();
  }

  @Test
  public void rustLinkerOverride() throws IOException, InterruptedException {
    ProjectWorkspace workspace =
        TestDataHelper.createProjectWorkspaceForScenario(this, "simple_binary", tmp);
    workspace.setUp();

    thrown.expect(HumanReadableException.class);
    thrown.expectMessage(
        Matchers.containsString("Overridden rust:linker path not found: bad-linker"));

    workspace
        .runBuckCommand("run", "--config", "rust.linker=bad-linker", "//:xyzzy")
        .assertFailure();
  }

  @Test
  public void rustLinkerCxxArgsOverride() throws IOException, InterruptedException {
    ProjectWorkspace workspace =
        TestDataHelper.createProjectWorkspaceForScenario(this, "simple_binary", tmp);
    workspace.setUp();

    // rust.linker_args always passed through
    assertThat(
        workspace
            .runBuckCommand("run", "--config", "rust.linker_args=-lbad-linker-args", "//:xyzzy")
            .getStderr(),
        Matchers.containsString("library not found for -lbad-linker-args"));
  }

  @Test
  public void rustLinkerRustArgsOverride() throws IOException, InterruptedException {
    ProjectWorkspace workspace =
        TestDataHelper.createProjectWorkspaceForScenario(this, "simple_binary", tmp);
    workspace.setUp();

    // rust.linker_args always passed through
    assertThat(
        workspace
            .runBuckCommand(
                "run",
                "--config",
                "rust.linker=/usr/bin/gcc", // need something that works
                "--config",
                "rust.linker_args=-lbad-linker-args",
                "//:xyzzy")
            .getStderr(),
        Matchers.containsString("library not found for -lbad-linker-args"));
  }

  @Test
  public void rustRuleLinkerFlagsOverride() throws IOException, InterruptedException {
    ProjectWorkspace workspace =
        TestDataHelper.createProjectWorkspaceForScenario(this, "simple_binary", tmp);
    workspace.setUp();

    assertThat(
        workspace.runBuckBuild("//:xyzzy_linkerflags").assertFailure().getStderr(),
        Matchers.containsString("this-is-a-bad-option"));
  }

  @Test
  public void rustTestRuleLinkerFlagsOverride() throws IOException, InterruptedException {
    ProjectWorkspace workspace =
        TestDataHelper.createProjectWorkspaceForScenario(this, "binary_with_tests", tmp);
    workspace.setUp();

    assertThat(
        workspace.runBuckBuild("//:test_success_linkerflags").assertFailure().getStderr(),
        Matchers.containsString("this-is-a-bad-option"));
  }

  @Test
  public void cxxLinkerOverride() throws IOException, InterruptedException {
    ProjectWorkspace workspace =
        TestDataHelper.createProjectWorkspaceForScenario(this, "simple_binary", tmp);
    workspace.setUp();

    thrown.expect(HumanReadableException.class);
    thrown.expectMessage(Matchers.containsString("Overridden cxx:ld path not found: bad-linker"));

    workspace.runBuckCommand("run", "--config", "cxx.ld=bad-linker", "//:xyzzy").assertFailure();
  }

  @Test
  public void cxxLinkerArgsOverride() throws IOException, InterruptedException {
    ProjectWorkspace workspace =
        TestDataHelper.createProjectWorkspaceForScenario(this, "simple_binary", tmp);
    workspace.setUp();

    // default linker gets cxx.ldflags
    assertThat(
        workspace
            .runBuckCommand("run", "--config", "cxx.ldflags=-lbad-linker-args", "//:xyzzy")
            .assertFailure()
            .getStderr(),
        Matchers.containsString("library not found for -lbad-linker-args"));
  }

  @Test
  public void cxxLinkerArgsNoOverride() throws IOException, InterruptedException {
    ProjectWorkspace workspace =
        TestDataHelper.createProjectWorkspaceForScenario(this, "simple_binary", tmp);
    workspace.setUp();

    // cxx.ldflags not used if linker overridden
    workspace
        .runBuckCommand(
            "run",
            "--config",
            "rust.linker=/usr/bin/gcc", // want to set it to something that will work
            "--config",
            "cxx.ldflags=-lbad-linker-args",
            "//:xyzzy")
        .assertSuccess();
  }

  @Test
  public void cxxLinkerDependency() throws IOException, InterruptedException {
    ProjectWorkspace workspace =
        TestDataHelper.createProjectWorkspaceForScenario(this, "simple_binary", tmp);
    workspace.setUp();

    workspace
        .runBuckCommand("run", "--config", "cxx.ld=//:generated_linker", "//:xyzzy")
        .assertSuccess();
  }
}