Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor global Jib config management #2996

Merged
merged 8 commits into from
Jan 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
import com.google.cloud.tools.jib.plugins.common.InvalidWorkingDirectoryException;
import com.google.cloud.tools.jib.plugins.common.MainClassInferenceException;
import com.google.cloud.tools.jib.plugins.common.PluginConfigurationProcessor;
import com.google.cloud.tools.jib.plugins.common.globalconfig.GlobalConfig;
import com.google.cloud.tools.jib.plugins.extension.JibPluginExtensionException;
import com.google.common.base.Preconditions;
import java.io.IOException;
Expand Down Expand Up @@ -105,7 +106,7 @@ public void buildDocker()
GradleProjectProperties projectProperties =
GradleProjectProperties.getForProject(getProject(), getLogger(), tempDirectoryProvider);
Future<Optional<String>> updateCheckFuture =
TaskCommon.newUpdateChecker(projectProperties, getLogger());
TaskCommon.newUpdateChecker(projectProperties, GlobalConfig.readConfig(), getLogger());
try {
PluginConfigurationProcessor.createJibBuildRunnerForDockerDaemonImage(
new GradleRawConfiguration(jibExtension),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
import com.google.cloud.tools.jib.plugins.common.InvalidWorkingDirectoryException;
import com.google.cloud.tools.jib.plugins.common.MainClassInferenceException;
import com.google.cloud.tools.jib.plugins.common.PluginConfigurationProcessor;
import com.google.cloud.tools.jib.plugins.common.globalconfig.GlobalConfig;
import com.google.cloud.tools.jib.plugins.extension.JibPluginExtensionException;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
Expand Down Expand Up @@ -93,7 +94,7 @@ public void buildImage()
GradleProjectProperties projectProperties =
GradleProjectProperties.getForProject(getProject(), getLogger(), tempDirectoryProvider);
Future<Optional<String>> updateCheckFuture =
TaskCommon.newUpdateChecker(projectProperties, getLogger());
TaskCommon.newUpdateChecker(projectProperties, GlobalConfig.readConfig(), getLogger());
try {
if (Strings.isNullOrEmpty(jibExtension.getTo().getImage())) {
throw new GradleException(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
import com.google.cloud.tools.jib.plugins.common.InvalidWorkingDirectoryException;
import com.google.cloud.tools.jib.plugins.common.MainClassInferenceException;
import com.google.cloud.tools.jib.plugins.common.PluginConfigurationProcessor;
import com.google.cloud.tools.jib.plugins.common.globalconfig.GlobalConfig;
import com.google.cloud.tools.jib.plugins.extension.JibPluginExtensionException;
import com.google.common.base.Preconditions;
import java.io.IOException;
Expand Down Expand Up @@ -126,7 +127,7 @@ public void buildTar()
GradleProjectProperties projectProperties =
GradleProjectProperties.getForProject(getProject(), getLogger(), tempDirectoryProvider);
Future<Optional<String>> updateCheckFuture =
TaskCommon.newUpdateChecker(projectProperties, getLogger());
TaskCommon.newUpdateChecker(projectProperties, GlobalConfig.readConfig(), getLogger());
try {
PluginConfigurationProcessor.createJibBuildRunnerForTarImage(
new GradleRawConfiguration(jibExtension),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import com.google.cloud.tools.jib.api.buildplan.FilePermissions;
import com.google.cloud.tools.jib.plugins.common.ProjectProperties;
import com.google.cloud.tools.jib.plugins.common.UpdateChecker;
import com.google.cloud.tools.jib.plugins.common.globalconfig.GlobalConfig;
import com.google.common.util.concurrent.Futures;
import java.util.LinkedHashMap;
import java.util.Map;
Expand All @@ -47,18 +48,20 @@ class TaskCommon {
public static final String VERSION_URL = "https://storage.googleapis.com/jib-versions/jib-gradle";

static Future<Optional<String>> newUpdateChecker(
ProjectProperties projectProperties, Logger logger) {
if (projectProperties.isOffline() || !logger.isLifecycleEnabled()) {
ProjectProperties projectProperties, GlobalConfig globalConfig, Logger logger) {
if (projectProperties.isOffline()
|| !logger.isLifecycleEnabled()
|| globalConfig.isDisableUpdateCheck()) {
return Futures.immediateFuture(Optional.empty());
}
ExecutorService executorService = Executors.newSingleThreadExecutor();
try {
return UpdateChecker.checkForUpdate(
executorService,
projectProperties::log,
VERSION_URL,
projectProperties.getToolName(),
projectProperties.getToolVersion());
projectProperties.getToolVersion(),
projectProperties::log);
} finally {
executorService.shutdown();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,11 @@
import com.google.cloud.tools.jib.plugins.common.InvalidWorkingDirectoryException;
import com.google.cloud.tools.jib.plugins.common.MainClassInferenceException;
import com.google.cloud.tools.jib.plugins.common.PluginConfigurationProcessor;
import com.google.cloud.tools.jib.plugins.common.globalconfig.GlobalConfig;
import com.google.cloud.tools.jib.plugins.extension.JibPluginExtensionException;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.util.concurrent.Futures;
import java.io.IOException;
import java.nio.file.Path;
import java.util.Optional;
Expand Down Expand Up @@ -82,9 +84,12 @@ public void execute() throws MojoExecutionException, MojoFailureException {
getSession(),
getLog(),
tempDirectoryProvider);
Future<Optional<String>> updateCheckFuture =
MojoCommon.newUpdateChecker(projectProperties, getLog());

Future<Optional<String>> updateCheckFuture = Futures.immediateFuture(Optional.empty());
try {
updateCheckFuture =
MojoCommon.newUpdateChecker(projectProperties, GlobalConfig.readConfig(), getLog());

PluginConfigurationProcessor.createJibBuildRunnerForDockerDaemonImage(
new MavenRawConfiguration(this),
new MavenSettingsServerCredentials(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,12 @@
import com.google.cloud.tools.jib.plugins.common.InvalidWorkingDirectoryException;
import com.google.cloud.tools.jib.plugins.common.MainClassInferenceException;
import com.google.cloud.tools.jib.plugins.common.PluginConfigurationProcessor;
import com.google.cloud.tools.jib.plugins.common.globalconfig.GlobalConfig;
import com.google.cloud.tools.jib.plugins.extension.JibPluginExtensionException;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
import com.google.common.util.concurrent.Futures;
import java.io.IOException;
import java.util.Arrays;
import java.util.Optional;
Expand Down Expand Up @@ -96,9 +98,12 @@ public void execute() throws MojoExecutionException, MojoFailureException {
getSession(),
getLog(),
tempDirectoryProvider);
Future<Optional<String>> updateCheckFuture =
MojoCommon.newUpdateChecker(projectProperties, getLog());

Future<Optional<String>> updateCheckFuture = Futures.immediateFuture(Optional.empty());
try {
updateCheckFuture =
MojoCommon.newUpdateChecker(projectProperties, GlobalConfig.readConfig(), getLog());

PluginConfigurationProcessor.createJibBuildRunnerForRegistryImage(
new MavenRawConfiguration(this),
new MavenSettingsServerCredentials(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,11 @@
import com.google.cloud.tools.jib.plugins.common.InvalidWorkingDirectoryException;
import com.google.cloud.tools.jib.plugins.common.MainClassInferenceException;
import com.google.cloud.tools.jib.plugins.common.PluginConfigurationProcessor;
import com.google.cloud.tools.jib.plugins.common.globalconfig.GlobalConfig;
import com.google.cloud.tools.jib.plugins.extension.JibPluginExtensionException;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.util.concurrent.Futures;
import java.io.IOException;
import java.util.Optional;
import java.util.concurrent.Future;
Expand Down Expand Up @@ -74,9 +76,12 @@ public void execute() throws MojoExecutionException, MojoFailureException {
getSession(),
getLog(),
tempDirectoryProvider);
Future<Optional<String>> updateCheckFuture =
MojoCommon.newUpdateChecker(projectProperties, getLog());

Future<Optional<String>> updateCheckFuture = Futures.immediateFuture(Optional.empty());
try {
updateCheckFuture =
MojoCommon.newUpdateChecker(projectProperties, GlobalConfig.readConfig(), getLog());

PluginConfigurationProcessor.createJibBuildRunnerForTarImage(
new MavenRawConfiguration(this),
new MavenSettingsServerCredentials(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@

package com.google.cloud.tools.jib.maven;

import static com.google.cloud.tools.jib.maven.JibPluginConfiguration.ExtraDirectoryParameters;

import com.google.cloud.tools.jib.ProjectInfo;
import com.google.cloud.tools.jib.api.LogEvent;
import com.google.cloud.tools.jib.api.buildplan.FilePermissions;
import com.google.cloud.tools.jib.maven.JibPluginConfiguration.ExtraDirectoryParameters;
import com.google.cloud.tools.jib.maven.JibPluginConfiguration.PermissionConfiguration;
import com.google.cloud.tools.jib.plugins.common.ProjectProperties;
import com.google.cloud.tools.jib.plugins.common.PropertyNames;
import com.google.cloud.tools.jib.plugins.common.UpdateChecker;
import com.google.cloud.tools.jib.plugins.common.VersionChecker;
import com.google.cloud.tools.jib.plugins.common.globalconfig.GlobalConfig;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.util.concurrent.Futures;
Expand Down Expand Up @@ -53,18 +53,20 @@ public class MojoCommon {
public static final String VERSION_URL = "https://storage.googleapis.com/jib-versions/jib-maven";

static Future<Optional<String>> newUpdateChecker(
ProjectProperties projectProperties, Log logger) {
if (projectProperties.isOffline() || !logger.isInfoEnabled()) {
ProjectProperties projectProperties, GlobalConfig globalConfig, Log logger) {
chanseokoh marked this conversation as resolved.
Show resolved Hide resolved
if (projectProperties.isOffline()
|| !logger.isInfoEnabled()
|| globalConfig.isDisableUpdateCheck()) {
return Futures.immediateFuture(Optional.empty());
}
ExecutorService executorService = Executors.newSingleThreadExecutor();
try {
return UpdateChecker.checkForUpdate(
executorService,
projectProperties::log,
VERSION_URL,
projectProperties.getToolName(),
projectProperties.getToolVersion());
projectProperties.getToolVersion(),
projectProperties::log);
} finally {
executorService.shutdown();
}
Expand Down
3 changes: 3 additions & 0 deletions jib-plugins-common/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ dependencies {
implementation dependencyStrings.EXTENSION_COMMON

testImplementation dependencyStrings.JUNIT
testImplementation dependencyStrings.JUNIT_PARAMS
testImplementation dependencyStrings.TRUTH
testImplementation dependencyStrings.TRUTH8
testImplementation dependencyStrings.MOCKITO_CORE
testImplementation dependencyStrings.SLF4J_API
testImplementation dependencyStrings.SYSTEM_RULES
Expand Down
Loading