FISH-898 Added timeout option to instance commands

[kalinchan]

Description

Added --timeout option

Important Info

Blockers

N/A

Testing

New tests

N/A

Testing Performed

Built Payara and tested timeout

Testing Environment

ubuntu 20.04 maven 3.6.3 openjdk version "1.8.0_302"

Documentation

payara/Payara-Community-Documentation#296

Notes for Reviewers

[kalinchan]

jenkins test please

[kalinchan]

jenkins test please

[Pandrex247]

I have issues with this.

I argue that this should also cover StartLocalInstanceCommand, StopLocalInstanceCommand, and RestartLocalInstanceCommand - they also manage the lifecycle of an instance.

I also argue that the restart-cluster, start-cluster, and stop-cluster commands should also have the timeout option.

I also think the way the start-instance command does it is a bit nicer (sidenote, we now have two different impls of how to perform a timeout) - utlising the internal managed executor service to wait after executing the command rather than spinning up a standalone unmanaged thread and executing the entire command within that.

    @Inject
    private PayaraExecutorService executor;
...
    /**
     * Poll for the specified amount of time to check if the instance is running.
     * Returns whether the instance was started before the timeout.
     * 
     * @return true if the instance started up, or false otherwise.
     */
    private boolean pollForLife(Server instance) {

        // Start a new thread to check when the instance has started
        CountDownLatch instanceTimeout = new CountDownLatch(1);
        ScheduledFuture<?> instancePollFuture = executor.scheduleWithFixedDelay(() -> {
            if (instance.isRunning()) {
                instanceTimeout.countDown();
            }
        }, 500, 500, MILLISECONDS);

        // If the timeout is reached, the instance isn't started so return false
        try {
            instanceTimeout.await(timeout, SECONDS);
        } catch (InterruptedException e) {
            return false;
        } finally {
            instancePollFuture.cancel(true);
        }
        
        return true;
    }

Also the restart-instance command timeout probably isn't working as expected. It seems to say the instance restarted successfully even if it hasn't actually restarted yet.
Running the below it reports that the instance was restarted successfully before the instance was even shut down.

restart-instance --timeout 1 Tender-Carp
Tender-Carp was restarted.
Command restart-instance executed successfully.

[Pandrex247]

You've still got competing timeouts

[kalinchan]

jenkins test please

[kalinchan]

jenkins test please

[Pandrex247]

Missing man page updates:

• stop-local-instance.1
• restart-local-instance.1
• start-local-instance.1
• stop-instance.1
• restart-instance.1
• start-instance.1
• stop-cluster.1
• start-cluster.1

[Pandrex247]

Jenkins test please