Skip to content

Commit af264fe

Browse files
ArdescoArdesco
committed
Refactor implementation. Now stores images to delete as a list in AbstractDockerMojo instead of passing around a maven property.
1 parent 6309e1f commit af264fe

5 files changed

Lines changed: 27 additions & 67 deletions

File tree

‎src/main/java/net/wouterdanes/docker/maven/AbstractDockerMojo.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public abstract class AbstractDockerMojo extends AbstractMojo {
6060
private static final String BUILT_IMAGES_KEY = "builtImages";
6161
private static final String PUSHABLE_IMAGES_KEY = "pushableImages";
6262
private static final String ERRORS_KEY = "errors";
63-
protected static final String IMAGE_LIST_PROPERTY = "docker.containers.to.remove.after.push";
63+
protected static ArrayList<String> imagesToDeleteAfterPush = new ArrayList<>();
6464

6565
@Component
6666
private RepositorySystem repositorySystem;

‎src/main/java/net/wouterdanes/docker/maven/BuildImageMojo.java‎

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,7 @@
2525
import org.apache.maven.plugins.annotations.LifecyclePhase;
2626
import org.apache.maven.plugins.annotations.Mojo;
2727
import org.apache.maven.plugins.annotations.Parameter;
28-
import org.apache.maven.project.MavenProject;
2928

30-
import java.util.ArrayList;
3129
import java.util.HashSet;
3230
import java.util.List;
3331
import java.util.Set;
@@ -43,9 +41,6 @@ public class BuildImageMojo extends AbstractPreVerifyDockerMojo {
4341
@Parameter(required = true)
4442
private List<ImageBuildConfiguration> images;
4543

46-
@Parameter(defaultValue = "${project}", readonly = true)
47-
private MavenProject project;
48-
4944
public void setImages(final List<ImageBuildConfiguration> images) {
5045
this.images = images;
5146
}
@@ -59,8 +54,6 @@ protected void doExecute() throws MojoExecutionException, MojoFailureException {
5954

6055
validateAllImages();
6156

62-
ArrayList<String> imagesToDeleteAfterPush = new ArrayList<>();
63-
6457
for (ImageBuildConfiguration image : images) {
6558
try {
6659
logImageConfig(image);
@@ -75,12 +68,6 @@ protected void doExecute() throws MojoExecutionException, MojoFailureException {
7568
handleDockerException(errorMessage, e);
7669
}
7770
}
78-
79-
if (imagesToDeleteAfterPush.size() > 0) {
80-
String listOfImagesToDeleteAfterPush = String.join(",", imagesToDeleteAfterPush);
81-
getLog().debug(String.format("Storing list of containers that need to be removed after a push: %s", listOfImagesToDeleteAfterPush));
82-
project.getProperties().setProperty(IMAGE_LIST_PROPERTY, listOfImagesToDeleteAfterPush);
83-
}
8471
}
8572

8673
private void logImageConfig(final ImageBuildConfiguration image) {
@@ -103,10 +90,6 @@ private void validateAllImages() throws MojoExecutionException {
10390
}
10491
}
10592

106-
public void setProject(MavenProject project) {
107-
this.project = project;
108-
}
109-
11093
@Override
11194
protected String getMojoGoalName() {
11295
return "build-images";

‎src/main/java/net/wouterdanes/docker/maven/PushImageMojo.java‎

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,8 @@
2525
import org.apache.maven.plugins.annotations.InstantiationStrategy;
2626
import org.apache.maven.plugins.annotations.LifecyclePhase;
2727
import org.apache.maven.plugins.annotations.Mojo;
28-
import org.apache.maven.plugins.annotations.Parameter;
29-
import org.apache.maven.project.MavenProject;
3028

31-
import java.util.Arrays;
3229
import java.util.Iterator;
33-
import java.util.List;
3430

3531
/**
3632
* This class is responsible for pushing docking images in the deploy phase of the maven build. The goal
@@ -40,9 +36,6 @@
4036
instantiationStrategy = InstantiationStrategy.PER_LOOKUP)
4137
public class PushImageMojo extends AbstractDockerMojo {
4238

43-
@Parameter(defaultValue = "${project}", readonly = true)
44-
private MavenProject project;
45-
4639
@Override
4740
public void doExecute() throws MojoExecutionException, MojoFailureException {
4841
ensureThatAllPushableImagesHaveAName();
@@ -58,15 +51,11 @@ public void doExecute() throws MojoExecutionException, MojoFailureException {
5851
}
5952
}
6053

61-
String listOfImagesToDeleteAfterPush = project.getProperties().getProperty(IMAGE_LIST_PROPERTY);
62-
if (listOfImagesToDeleteAfterPush != null) {
63-
List<String> imageIDs = Arrays.asList(listOfImagesToDeleteAfterPush.split(","));
64-
for (String imageID : imageIDs) {
65-
try {
66-
getDockerProvider().removeImage(imageID);
67-
} catch (DockerException e) {
68-
getLog().error("Failed to remove image", e);
69-
}
54+
for (String imageID : imagesToDeleteAfterPush) {
55+
try {
56+
getDockerProvider().removeImage(imageID);
57+
} catch (DockerException e) {
58+
getLog().error("Failed to remove image", e);
7059
}
7160
}
7261
}
@@ -83,8 +72,4 @@ private void ensureThatAllPushableImagesHaveAName() throws MojoFailureException
8372
throw new MojoFailureException("There are images that need to be pushed without a name.");
8473
}
8574
}
86-
87-
public void setProject(MavenProject project) {
88-
this.project = project;
89-
}
9075
}

‎src/test/java/net/wouterdanes/docker/maven/BuildImageMojoTest.java‎

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,16 @@
2424
import net.wouterdanes.docker.provider.model.PushableImage;
2525
import org.apache.maven.plugin.MojoExecutionException;
2626
import org.apache.maven.plugin.MojoFailureException;
27-
import org.apache.maven.project.MavenProject;
2827
import org.junit.After;
2928
import org.junit.Before;
3029
import org.junit.Test;
3130
import org.mockito.Mockito;
3231

3332
import java.util.*;
3433

35-
import static net.wouterdanes.docker.maven.AbstractDockerMojo.IMAGE_LIST_PROPERTY;
34+
import static net.wouterdanes.docker.maven.AbstractDockerMojo.imagesToDeleteAfterPush;
3635
import static org.junit.Assert.*;
3736
import static org.mockito.Matchers.any;
38-
import static org.mockito.Mockito.mock;
39-
import static org.mockito.Mockito.when;
4037

4138
public class BuildImageMojoTest {
4239

@@ -49,18 +46,15 @@ public class BuildImageMojoTest {
4946
private static final String REGISTRY = UUID.randomUUID().toString();
5047
private static final String REGISTRYANDNAMEANDTAG = REGISTRY + "/" + NAMEANDTAG;
5148

52-
private final MavenProject mavenProject = mock(MavenProject.class);
5349
private BuildImageMojo mojo = new BuildImageMojo();
5450

5551
private ImageBuildConfiguration mockImage;
5652

5753
@Before
5854
public void setUp() throws Exception {
55+
imagesToDeleteAfterPush = new ArrayList<>();
5956
mojo.setPluginContext(new HashMap());
6057

61-
Properties mavenProjectProperties = new Properties();
62-
when(mavenProject.getProperties()).thenReturn(mavenProjectProperties);
63-
6458
FakeDockerProvider.instance = Mockito.mock(FakeDockerProvider.class);
6559
Mockito.when(FakeDockerProvider.instance.buildImage(any(ImageBuildConfiguration.class))).thenReturn(IMAGEID);
6660

@@ -80,6 +74,7 @@ public void setUp() throws Exception {
8074
@After
8175
public void tearDown() throws Exception {
8276
DockerProviderSupplier.removeProvider(FAKE_PROVIDER_KEY);
77+
imagesToDeleteAfterPush = new ArrayList<>();
8378
}
8479

8580
@Test
@@ -156,7 +151,7 @@ public void imageListPropertyNotSetWhenImageIsPushAndIsKeep() throws Exception {
156151
PushableImage actual = mojo.getImagesToPush().get(0);
157152

158153
assertEquals(BuildImageMojoTest.IMAGEID, actual.getImageId());
159-
assertEquals(null, mavenProject.getProperties().getProperty(IMAGE_LIST_PROPERTY));
154+
assertEquals(0, imagesToDeleteAfterPush.size());
160155
}
161156

162157
@Test
@@ -167,24 +162,29 @@ public void imageListPropertyNotSetWhenImageIsNotPushAndIsNotKeep() throws Excep
167162
executeMojo(FAKE_PROVIDER_KEY);
168163

169164
assertEquals(0, mojo.getImagesToPush().size());
170-
assertEquals(null, mavenProject.getProperties().getProperty(IMAGE_LIST_PROPERTY));
165+
assertEquals(0, imagesToDeleteAfterPush.size());
171166
}
172167

173168
@Test
174169
public void imageListPropertySetWhenImageIsPushButNotIsKeep() throws Exception {
170+
ArrayList<String> expectedImagesToBeDeletedAfterPush = new ArrayList<>();
171+
175172
Mockito.when(mockImage.isPush()).thenReturn(true);
176173
Mockito.when(mockImage.isKeep()).thenReturn(false);
177174

178175
executeMojo(FAKE_PROVIDER_KEY);
179176

180177
assertEquals(1, mojo.getImagesToPush().size());
181178

182-
assertEquals(mojo.getImagesToPush().get(0).getImageId(),
183-
mavenProject.getProperties().getProperty(IMAGE_LIST_PROPERTY));
179+
expectedImagesToBeDeletedAfterPush.add(mojo.getImagesToPush().get(0).getImageId());
180+
181+
assertEquals(imagesToDeleteAfterPush, expectedImagesToBeDeletedAfterPush);
184182
}
185183

186184
@Test
187185
public void imageListPropertySetWhenMultipleImagesSetToIsPushButNotIsKeep() throws Exception {
186+
ArrayList<String> expectedImagesToBeDeletedAfterPush = new ArrayList<>();
187+
188188
Mockito.when(mockImage.isPush()).thenReturn(true);
189189
Mockito.when(mockImage.isKeep()).thenReturn(false);
190190

@@ -203,15 +203,14 @@ public void imageListPropertySetWhenMultipleImagesSetToIsPushButNotIsKeep() thro
203203

204204
assertEquals(2, mojo.getImagesToPush().size());
205205

206-
String expectedImageListPropertyValue = mojo.getImagesToPush().get(0).getImageId() + "," + mojo.getImagesToPush().get(1).getImageId();
206+
expectedImagesToBeDeletedAfterPush.add(mojo.getImagesToPush().get(0).getImageId());
207+
expectedImagesToBeDeletedAfterPush.add(mojo.getImagesToPush().get(1).getImageId());
207208

208-
assertEquals(expectedImageListPropertyValue,
209-
mavenProject.getProperties().getProperty(IMAGE_LIST_PROPERTY));
209+
assertEquals(imagesToDeleteAfterPush, expectedImagesToBeDeletedAfterPush);
210210
}
211211

212212
private void executeMojo(String provider) throws MojoExecutionException, MojoFailureException {
213213
mojo.setProviderName(provider);
214-
mojo.setProject(mavenProject);
215214
mojo.execute();
216215
}
217216

‎src/test/java/net/wouterdanes/docker/maven/PushImageMojoTest.java‎

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,35 +21,31 @@
2121
import net.wouterdanes.docker.provider.DockerProviderSupplier;
2222
import net.wouterdanes.docker.provider.model.ImageBuildConfiguration;
2323
import org.apache.maven.plugin.MojoFailureException;
24-
import org.apache.maven.project.MavenProject;
2524
import org.junit.After;
2625
import org.junit.Before;
2726
import org.junit.Test;
2827
import org.mockito.Matchers;
2928
import org.mockito.Mockito;
3029
import org.mockito.internal.verification.VerificationModeFactory;
3130

31+
import java.util.ArrayList;
3232
import java.util.HashMap;
3333
import java.util.Optional;
34-
import java.util.Properties;
3534
import java.util.UUID;
3635

37-
import static net.wouterdanes.docker.maven.AbstractDockerMojo.IMAGE_LIST_PROPERTY;
3836
import static org.mockito.Mockito.*;
3937

4038
public class PushImageMojoTest {
4139

4240
private final String fakeProviderKey = UUID.randomUUID().toString();
43-
private final MavenProject mavenProject = mock(MavenProject.class);
4441
private PushImageMojo mojo;
4542
private ImageBuildConfiguration mockImage;
4643

4744
private static final String NAME_AND_TAG = UUID.randomUUID().toString();
4845

4946
@Before
5047
public void setUp() throws Exception {
51-
Properties mavenProjectProperties = new Properties();
52-
when(mavenProject.getProperties()).thenReturn(mavenProjectProperties);
48+
AbstractDockerMojo.imagesToDeleteAfterPush = new ArrayList<>();
5349

5450
mockImage = Mockito.mock(ImageBuildConfiguration.class);
5551
Mockito.when(mockImage.getNameAndTag()).thenReturn(NAME_AND_TAG);
@@ -60,15 +56,13 @@ public void setUp() throws Exception {
6056

6157
mojo = new PushImageMojo();
6258
mojo.setPluginContext(new HashMap());
63-
mojo.setProject(mavenProject);
6459
mojo.setProviderName(fakeProviderKey);
6560
}
6661

6762
@After
6863
public void tearDown() throws Exception {
69-
7064
DockerProviderSupplier.removeProvider(fakeProviderKey);
71-
65+
AbstractDockerMojo.imagesToDeleteAfterPush = new ArrayList<>();
7266
}
7367

7468
@Test(expected = MojoFailureException.class)
@@ -101,8 +95,7 @@ public void willNotRemoveImagesIfImageListPropertyIsNotSet() throws Exception {
10195

10296
@Test
10397
public void willRemoveImagesIfImageListPropertyContainsASingleID() throws Exception {
104-
105-
mavenProject.getProperties().setProperty(IMAGE_LIST_PROPERTY, "some-image-id");
98+
AbstractDockerMojo.imagesToDeleteAfterPush.add("some-image-id");
10699

107100
mojo.enqueueForPushing("some-image-id", mockImage);
108101
mojo.enqueueForPushing("another-image-id", mockImage);
@@ -113,8 +106,8 @@ public void willRemoveImagesIfImageListPropertyContainsASingleID() throws Except
113106

114107
@Test
115108
public void willRemoveImagesIfImageListPropertyContainsMultipleIDs() throws Exception {
116-
117-
mavenProject.getProperties().setProperty(IMAGE_LIST_PROPERTY, "some-image-id,another-image-id");
109+
AbstractDockerMojo.imagesToDeleteAfterPush.add("some-image-id");
110+
AbstractDockerMojo.imagesToDeleteAfterPush.add("some-image-id,another-image-id");
118111

119112
mojo.enqueueForPushing("some-image-id", mockImage);
120113
mojo.enqueueForPushing("another-image-id", mockImage);

0 commit comments

Comments
 (0)