Add RecordingFileFactory with default implementation #507

ldeck · 2017-11-27T18:10:26Z

By default this returns a file in the given vlc recording directory named <RESULT>-<TestClassName>-<testMethodName>-<YYYYMMdd-HHmmss>.flv, where RESULT is either PASSED or FAILED.

A custom factory can be provided to BrowserWebDriverContainer#withRecordingFileFactory.

The factory is only applicable if the BrowserWebDriverContainer#recordingMode enables the retention of recordings.

Fixes #500.

By default this returns a file in the given vlc recording directory named '<RESULT>-<TestClassName>-<testMethodName>-<YYYYMMdd-HHmmss>.flv', where RESULT is either 'PASSED' or 'FAILED'. A custom factory can be provided to BrowserWebDriverContainer#withRecordingFileFactory. The factory is only applicable if the BrowserWebDriverContainer#recordingMode enables the retention of recordings. Fixes testcontainers#500.

Fixes testcontainers#500

kiview · 2017-12-05T21:44:33Z

modules/selenium/src/main/java/org/testcontainers/containers/DefaultRecordingFileFactory.java

+
+    @Override
+    public File recordingFileForTest(File vncRecordingDirectory, Description description, boolean succeeded) {
+        final String prefix = succeeded ? "PASSED" : "FAILED";


I think we should put those Strings into constants.

kiview · 2017-12-05T21:44:51Z

modules/selenium/src/main/java/org/testcontainers/containers/DefaultRecordingFileFactory.java

+    @Override
+    public File recordingFileForTest(File vncRecordingDirectory, Description description, boolean succeeded) {
+        final String prefix = succeeded ? "PASSED" : "FAILED";
+        final String fileName = String.format("%s-%s-%s-%s.flv",


This String should also got into a constant.

kiview · 2017-12-05T21:47:38Z

modules/selenium/src/main/java/org/testcontainers/containers/BrowserWebDriverContainer.java

-        File recordingFile = new File(vncRecordingDirectory, "recording-" + filenameDateFormat.format(new Date()) + ".flv");
-
+    private void stopAndRetainRecording(Description description, boolean succeeded) {
+        File recordingFile = recordingFileFactory.recordingFileForTest(vncRecordingDirectory, description, succeeded);
        LOGGER.info("Screen recordings for test {} will be stored at: {}", description.getDisplayName(), recordingFile);


I know this is not part of your PR, but this line will fail for none JUnit usages (since no Description will be available). Is the Description actually needed?

Ok. Is there a test-case for that in the codebase already?
Or better, if the description is null what should the factory default to?

I see you are using Description for the values of your recorder as well. I think it's okay for now, since we won't break the current API (which is kind of JUnit4 focused after all). We can refactor this part in the future. I'll check if it works like this with testcontainers-spock out of the box.

kiview · 2017-12-05T21:51:35Z

modules/selenium/src/main/java/org/testcontainers/containers/BrowserWebDriverContainer.java

-    private void stopAndRetainRecording(Description description) {
-        File recordingFile = new File(vncRecordingDirectory, "recording-" + filenameDateFormat.format(new Date()) + ".flv");
-
+    private void stopAndRetainRecording(Description description, boolean succeeded) {


Is there a way to rename this method such that the meaning of the parameter becomes more clear in the using code?
Maybe something along the lines of stopAndRetainRecordingForDescriptionAndSuccessState (very long, yes =/).

Sure. Need smalltalk / Objective-C / scala named args :-)

kiview · 2017-12-05T21:54:04Z

...es/selenium/src/test/java/org/testcontainers/containers/DefaultRecordingFileFactoryTest.java

+    public static Collection<Object[]> data() {
+        Random random = new Random();
+        Collection<Object[]> args = new ArrayList<>();
+        args.add(new Object[]{format("testMethodName%d", random.nextInt()), "FAILED", FALSE});


Random values in unit tests? What do you need them for?

Yep, overkill.

kiview · 2017-12-05T21:55:49Z

...s/selenium/src/test/java/org/testcontainers/junit/ChromeRecordingWebDriverContainerTest.java

@@ -17,7 +18,8 @@
    @Rule
    public BrowserWebDriverContainer chromeThatRecordsAllTests = new BrowserWebDriverContainer()
            .withDesiredCapabilities(DesiredCapabilities.chrome())
-            .withRecordingMode(RECORD_ALL, new File("./target/"));
+            .withRecordingMode(RECORD_ALL, new File("./target/"))
+            .withRecordingFileFactory(new DefaultRecordingFileFactory());


Isn't this already used implicitly? Or did you want to make in explicit in this test?

Yeah, it is used implicitly, but wanted to ensure that if you specifically attempted to provide your own factory that it would still succeed.

Ok, makes sense.

Fixes testcontainers#500.

kiview · 2017-12-07T22:36:30Z

I just restarted the CI build, failing was unrelated.

rnorth

This is really good - thanks for the contribution. I just have a couple of comments on the code. Also, if you wouldn't mind adding at least a changelog comment it'd be good - this changes the output people will get, so we need to alert them. (Probably doesn't warrant a breaking change version bump though)

We will need to think about adding docs to describe this feature, but we can do that separately if you don't have time.
Thanks again for doing this!

rnorth · 2017-12-07T22:51:11Z

...es/selenium/src/test/java/org/testcontainers/containers/DefaultRecordingFileFactoryTest.java

+                prefix,
+                getClass().getSimpleName(),
+                methodName,
+                DATE_FORMAT.format(new Date()))


I'm sorry to be pedantic, but I think there is a small risk that this test will be flaky... If it's running right on the transition from one second to the next, we're going to see a different date 😬

Would it be possible to do some assertions on the file name instead, e.g. a string comparison that ignores the time part?

Sure. Freezing the date during the test would be ideal.

Actually, how about I check for both now and one second ago?

rnorth · 2017-12-07T22:54:27Z

modules/selenium/src/main/java/org/testcontainers/containers/RecordingFileFactory.java

+
+import java.io.File;
+
+public interface RecordingFileFactory {


Would it be OK to change this to RecordingFileNameFactory (and also rename the implementation)?

The reason I ask is that changing the filename seems to basically be the intent. The parent folder is already controlled separately, so all the user is really able to do is change the filename (unless I'm being very unimaginative 😄 )

Certainly the original intent was to enable the file name to match the test name so that it was more easily identified.

Providing a custom factory, however, (if you want to alter the default we've now provided) means that setting the parent directory elsewhere is not necessary. i.e., you can ignore the vncRecordingDirectory argument.

I'm happy to rename it if you prefer?

I wonder if the vncRecordingDirectory should be a property of the factory instead of the browser web driver container? That, of course, would be a breaking change—or perhaps a deprecated one.

I've added docs now too.

Let me know about the above thoughts. That, I think, is the last bit left.

^^ I get it, OK. Let's keep as-is. I agree with the idea of setting the parent directory here, but as you say it would be a breaking change so let's save it for another day :)

Thank you also for the docs updates!

…ferences. Fixes testcontainers#500.

Fixes testcontainers#500.

ldeck added 2 commits November 28, 2017 05:06

Fix Codacy failures/warnings

30dcbb7

Fixes testcontainers#500

kiview requested changes Dec 5, 2017

View reviewed changes

Code review requested changes

0798524

Fixes testcontainers#500.

kiview approved these changes Dec 7, 2017

View reviewed changes

kiview requested a review from rnorth December 7, 2017 22:55

rnorth requested changes Dec 7, 2017

View reviewed changes

ldeck added 4 commits December 9, 2017 16:28

Avoiding nano-second risk of test failures due to datetime format dif…

4462951

…ferences. Fixes testcontainers#500.

Add changelog for custom file name factory

b42082f

Fixes testcontainers#500.

Add docs for BrowserWebDriverContainer#withRecordingFileFactory

bb28bed

Fixes testcontainers#500.

Update docs for BrowserWebDriverContainer#withRecordingFileFactory

e014048

Fixes testcontainers#500.

rnorth approved these changes Dec 9, 2017

View reviewed changes

rnorth merged commit 6620d23 into testcontainers:master Dec 9, 2017

ldeck deleted the add-selenium-recording-file-factory branch December 11, 2017 19:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add RecordingFileFactory with default implementation #507

Add RecordingFileFactory with default implementation #507

ldeck commented Nov 27, 2017

kiview Dec 5, 2017

ldeck Dec 6, 2017

kiview Dec 5, 2017

ldeck Dec 6, 2017

kiview Dec 5, 2017

ldeck Dec 6, 2017

kiview Dec 7, 2017

kiview Dec 5, 2017

ldeck Dec 6, 2017

kiview Dec 5, 2017

ldeck Dec 6, 2017

kiview Dec 5, 2017

ldeck Dec 6, 2017

kiview Dec 7, 2017

kiview commented Dec 7, 2017

rnorth left a comment

rnorth Dec 7, 2017

ldeck Dec 9, 2017

ldeck Dec 9, 2017

rnorth Dec 7, 2017

ldeck Dec 9, 2017 •

edited

Loading

ldeck Dec 9, 2017 •

edited

Loading

ldeck Dec 9, 2017

ldeck Dec 9, 2017

rnorth Dec 9, 2017

Add RecordingFileFactory with default implementation #507

Add RecordingFileFactory with default implementation #507

Conversation

ldeck commented Nov 27, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kiview commented Dec 7, 2017

rnorth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ldeck Dec 9, 2017 • edited Loading

Choose a reason for hiding this comment

ldeck Dec 9, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ldeck Dec 9, 2017 •

edited

Loading

ldeck Dec 9, 2017 •

edited

Loading