google-nomulus/javatests/google/registry/testing/GpgSystemCommandRule.java
shikhman f76bc70f91 Preserve test logs and test summary output for Kokoro CI runs
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=135494972
2016-10-14 16:57:43 -04:00

108 lines
3.6 KiB
Java

// Copyright 2016 The Nomulus Authors. All Rights Reserved.
//
// 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 google.registry.testing;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import static com.google.common.truth.Truth.assertWithMessage;
import com.google.common.io.ByteSource;
import java.io.File;
import java.io.IOException;
import org.junit.rules.ExternalResource;
/**
* GnuPG system command JUnit rule.
*
* <p>This rule creates a isolated environment for running the {@code gpg} command inside system
* integration tests. It reduces a lot of the boilerplate of setting up the shell environment and
* importing your keyrings into a temporary config folder.
*
* @see ExternalResource
*/
public final class GpgSystemCommandRule extends ExternalResource {
private static final File DEV_NULL = new File("/dev/null");
private static final String TEMP_FILE_PREFIX = "gpgtest";
private File cwd = DEV_NULL;
private File conf = DEV_NULL;
private String[] env = {};
private final ByteSource publicKeyring;
private final ByteSource privateKeyring;
private final Runtime runtime = Runtime.getRuntime();
/** Constructs a new {@link GpgSystemCommandRule} instance. */
public GpgSystemCommandRule(ByteSource publicKeyring, ByteSource privateKeyring) {
this.publicKeyring = checkNotNull(publicKeyring, "publicKeyring");
this.privateKeyring = checkNotNull(privateKeyring, "privateKeyring");
}
/** Returns the temporary directory from which commands are run. */
public File getCwd() {
checkState(cwd != DEV_NULL);
return cwd;
}
/** Returns the temporary directory in which GnuPG configs are stored. */
public File getConf() {
checkState(conf != DEV_NULL);
return conf;
}
/**
* Runs specified system command and arguments within the GPG testing environment.
*
* @throws IOException
* @see Runtime#exec(String[])
*/
public final Process exec(String... args) throws IOException {
checkState(cwd != DEV_NULL);
checkArgument(args.length > 0, "args");
return runtime.exec(args, env, cwd);
}
@Override
protected void before() throws IOException, InterruptedException {
checkState(cwd == DEV_NULL);
cwd = File.createTempFile(TEMP_FILE_PREFIX, "", null);
cwd.delete();
cwd.mkdir();
conf = new File(cwd, ".gnupg");
conf.mkdir();
conf.setReadable(true, true);
env = new String[] {
"PATH=" + System.getenv("PATH"),
"GNUPGHOME=" + conf.getAbsolutePath(),
};
Process pid = exec("gpg", "--import");
publicKeyring.copyTo(pid.getOutputStream());
pid.getOutputStream().close();
assertWithMessage("Failed to import public keyring").that(pid.waitFor()).isEqualTo(0);
pid = exec("gpg", "--allow-secret-key-import", "--import");
privateKeyring.copyTo(pid.getOutputStream());
pid.getOutputStream().close();
assertWithMessage("Failed to import private keyring").that(pid.waitFor()).isEqualTo(0);
}
@Override
protected void after() {
cwd = DEV_NULL;
conf = DEV_NULL;
}
}