Only saving failed vidoes

[cyborgx-99]

Hi,
Is it possible to only save failed videos on the hub? We have a grid setup of 200+ machines and if I run a test on all of them, it creates a video file for each one between 15-30mb, and then copies each one across to the hub. This obviously takes a lot of time & the report takes forever to generate as a result. Any pointers on how I can improve this process?

Cheers

[aimmac23]

Hi cyborg-x99,

It... might be possible.

I am a bit curious - does it really take that long to copy a file onto your grid hub? If the files were 15Mb, I would have thought it's because the tests are running a while?

Is it possible to include only failing videos in your report? I'm not sure what you're doing to compile your report, and I'd quite like to know more (my main experience with test reports was with a proprietary internal system).

The main problem with this is that Selenium knows nothing about JUnit test status (or equivalent test framework). One solution to this could be to add a new HTTP servlet call to the Hub to tell it to discard the video when the Selenium session closes.

Does that sound like that would help?

Thanks,

Alasdair

[cyborgx-99]

The tests take anywhere from 2-4 minutes to run. I've been looking into this a bit more, all the files actually copy across but the hub seems to freeze up. I have to force the hub to shutdown at which point the report is able to complete generating. I'm using ReportNg where I add a link to the video file on completion of the test.

I can add a new servlet, but what I'd like to do is stop the hub from copying the file in the first place. Does that sound possible?

Thanks

[aimmac23]

That sounds quite strange - it could be a bug somewhere.

Can you take a thread dump of the hub and paste it online somewhere? I suspect there could be another issue at work here.

Some example instructions here:

https://helpx.adobe.com/experience-manager/kb/TakeThreadDump.html

Thanks,

Alasdair

[cyborgx-99]

OK, the next time I encounter the issue again, I will take a thread dump and post on here.
Thanks

[saikek]

I've looked into this issue - it seems like if you have only one node it's very easy :).
You can move servlet part to your host machine.
If you are using TestNg to start Selenium tests you can override methods
BeforeSuite, before, after to init servlet, start recording and stop recording.
Save recording if test failed, otherwise remove it.

if (testResult.getStatus() == ITestResult.FAILURE) {
}

[aimmac23]

Well, that's one way to do it, I guess.

What if we had a DELETE API call the test could use on success? It sounded like the original issue was related to networking/selenium/connection pooling, so I'm not sure it would help.

[saikek]

At this point i had moved all the code from Proxy to a separate class.
So i don't need Server servlet, and proxy class, but only this Root test class & your Node servlet.
Out test system deploys enviroment with only 1 selenium node, so it works fine this way.
Not that cleanup is not done, i haven't thought about it yet.
Just i'm not sure that i want to use selenium sessions.

package com.ca.apm.test.atc;

import com.aimmac23.hub.videostorage.IVideoStore;
import com.aimmac23.hub.videostorage.LocalFileVideoStore;
import com.ca.tas.annotation.TasResource;
import com.ca.tas.test.TasTestNgTest;
import org.apache.http.Header;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
import org.json.JSONObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.testng.ITestResult;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.AfterSuite;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.BeforeSuite;

import java.lang.reflect.Method;

public abstract class VideoRecordingCapableTest {
    private VideoProxy videoProxy;
    private String fileKey = "";

    protected abstract String getSeleniumNodeHostAndPort();
    protected abstract String getFailedTestsVideoStorageLocation();

    @BeforeSuite
    public void beforeSuite() {
        videoProxy = new VideoProxy(getSeleniumNodeHostAndPort());
        videoProxy.restartRecording();
    }

    @AfterSuite
    public void afterSuite(){

        //REMOVE all resources from node ?
    }

    @BeforeMethod
    public void before(Method method) throws Exception {
        videoProxy.startRecording();
    }

    @AfterMethod
    public void after(ITestResult testResult) {
        videoProxy.stopRecording();

        waitIfWeHanventStoppedSessionYet();

        if (testResult.getStatus() == ITestResult.FAILURE) {
            String className = testResult.getMethod().getMethodName();
            String methodName = testResult.getMethod().getTestClass().getName();

            videoProxy.transferVideo(fileKey, className + "." + methodName);
        }
    }

    private void waitIfWeHanventStoppedSessionYet() {
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }

    class VideoProxy {
        private final Logger log = LoggerFactory.getLogger(getClass());
        boolean isCurrentlyRecording = false;
        private IVideoStore videoStore;

        private String serviceUrl;
        private HttpClient client;

        public VideoProxy(String hostAndPort) {
            serviceUrl = hostAndPort + "/extra/VideoRecordingControlServlet";

            client = HttpClientBuilder.create().build();

            System.setProperty("video.path", getFailedTestsVideoStorageLocation());

            videoStore = new LocalFileVideoStore();
        }

        public String getId() {
            return "Something";
        }

        void restartRecording() {
            // its possible that the Hub may have crashed/been terminated/lost network connection, leaving the
            // node still recording. Tell it to get back to a known-state (https://github.com/aimmac23/selenium-video-node/issues/5)
            HttpPost r = new HttpPost(serviceUrl + "?command=reset"); //NODE IP
            try {
                HttpResponse response = client.execute(r);

                if (response.getStatusLine().getStatusCode() != HttpStatus.SC_OK) {
                    String body = EntityUtils.toString(response.getEntity());
                    log.warn("Could not reset node {} to known recording status - incorrect HTTP response. " +
                                    "Got: HTTP {} code with body: '{}'",
                            this.getId(), response.getStatusLine().getStatusCode(), body
                    );
                }

            } catch (Exception e) {
                log.warn("Could not reset node " + this.getId() +
                        " to known recording status - caught exception", e);
            } finally {
                r.releaseConnection();
            }
        }

        void startRecording() {
            HttpPost r = new HttpPost(serviceUrl + "?command=start");

            try {
                HttpResponse response = client.execute(r);
                if (response.getStatusLine().getStatusCode() != HttpStatus.SC_OK) {
                    log.warn("Could not start video reporting: {}", EntityUtils.toString(response.getEntity()));
                    return;
                }

                isCurrentlyRecording = true;

                log.info("Started recording for new session on node: " + getId());

            } catch (Exception e) {
                log.error("Could not start video reporting due to exception:", e);
                return;
            } finally {
                r.releaseConnection();
            }
        }

        void stopRecording() {
            //TODO - SET SESSION AS STOPPING
            HttpPost r = new HttpPost(serviceUrl + "?command=stop");

            try {
                HttpResponse response = client.execute(r);
                if (response.getStatusLine().getStatusCode() != HttpStatus.SC_OK) {
                    log.warn("Could not stop video reporting: {}", EntityUtils.toString(response.getEntity()));
                }

                JSONObject json = new JSONObject(EntityUtils.toString(response.getEntity()));
                fileKey = json.getString("filekey");

                isCurrentlyRecording = false;
            } catch (Exception e) {
                log.error("Could not stop video reporting due to exception:", e);
            } finally {
                r.releaseConnection();
            }
        }

        private void transferVideo(String fileKey, String fileName) { //TODO - check if file can be created
            HttpGet r = new HttpGet(serviceUrl + "?command=download&filekey=" + fileKey);

            try {
                HttpResponse response = client.execute(r);
                if (response.getStatusLine().getStatusCode() != HttpStatus.SC_OK) {
                    log.warn("Could not download video: {}", EntityUtils.toString(response.getEntity()));
                    return;
                }

                Header contentType = response.getFirstHeader("Content-Type");
                if (contentType != null && !"video/webm".equals(contentType.getValue())) {
                    log.warn("Incorrect 'Content-Type' header when downloading video - "
                            + "check that the control servlet is correctly setup for node: {}", serviceUrl);
                } else {
                    videoStore.storeVideo(response.getEntity().getContent(), response.getEntity().getContentLength(), "video/webm", fileName, null);
                }

            } catch (Exception e) {
                log.error("Could not download video, exception caught: ", e);
            } finally {
                r.releaseConnection();

                //TODO - CLEANUP IS NOT DONE, since we don't know Selenium session number!
            }
        }
    }
}