Mailing-List: contact dev-help@brooklyn.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@brooklyn.apache.org
From: aledsage <git@git.apache.org>
To: dev@brooklyn.apache.org
Reply-To: dev@brooklyn.apache.org
References: <git-pr-186-brooklyn-server@git.apache.org>
In-Reply-To: <git-pr-186-brooklyn-server@git.apache.org>
Subject: [GitHub] brooklyn-server pull request #186: Rename SimpleShellCommandTest to TestSshC...
Content-Type: text/plain
Message-Id: <20160607140054.10E89DFC71@git1-us-west.apache.org>
Date: Tue,  7 Jun 2016 14:00:54 +0000 (UTC)
archived-at: Tue, 07 Jun 2016 14:00:56 -0000

Github user aledsage commented on a diff in the pull request:

    https://github.com/apache/brooklyn-server/pull/186#discussion_r66075624
  
    --- Diff: test-framework/src/main/java/org/apache/brooklyn/test/framework/TestSshCommandImpl.java ---
    @@ -0,0 +1,269 @@
    +/*
    + * Licensed to the Apache Software Foundation (ASF) under one
    + * or more contributor license agreements.  See the NOTICE file
    + * distributed with this work for additional information
    + * regarding copyright ownership.  The ASF licenses this file
    + * to you under the Apache License, Version 2.0 (the
    + * "License"); you may not use this file except in compliance
    + * with the License.  You may obtain a copy of the License at
    + *
    + *     http://www.apache.org/licenses/LICENSE-2.0
    + *
    + * Unless required by applicable law or agreed to in writing,
    + * software distributed under the License is distributed on an
    + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    + * KIND, either express or implied.  See the License for the
    + * specific language governing permissions and limitations
    + * under the License.
    + */
    +package org.apache.brooklyn.test.framework;
    +
    +import static org.apache.brooklyn.core.entity.lifecycle.Lifecycle.ON_FIRE;
    +import static org.apache.brooklyn.core.entity.lifecycle.Lifecycle.RUNNING;
    +import static org.apache.brooklyn.core.entity.lifecycle.Lifecycle.STARTING;
    +import static org.apache.brooklyn.core.entity.lifecycle.Lifecycle.STOPPED;
    +import static org.apache.brooklyn.core.entity.lifecycle.ServiceStateLogic.setExpectedState;
    +import static org.apache.brooklyn.test.framework.TestFrameworkAssertions.checkAssertions;
    +import static org.apache.brooklyn.test.framework.TestFrameworkAssertions.getAssertions;
    +import static org.apache.brooklyn.util.text.Strings.isBlank;
    +import static org.apache.brooklyn.util.text.Strings.isNonBlank;
    +
    +import java.net.MalformedURLException;
    +import java.net.URL;
    +import java.util.Arrays;
    +import java.util.Collection;
    +import java.util.Collections;
    +import java.util.Iterator;
    +import java.util.List;
    +import java.util.Map;
    +
    +import org.apache.brooklyn.api.location.Location;
    +import org.apache.brooklyn.api.mgmt.TaskFactory;
    +import org.apache.brooklyn.core.effector.ssh.SshEffectorTasks;
    +import org.apache.brooklyn.core.entity.lifecycle.Lifecycle;
    +import org.apache.brooklyn.core.location.Machines;
    +import org.apache.brooklyn.location.ssh.SshMachineLocation;
    +import org.apache.brooklyn.test.framework.TestFrameworkAssertions.AssertionSupport;
    +import org.apache.brooklyn.util.collections.MutableList;
    +import org.apache.brooklyn.util.core.task.DynamicTasks;
    +import org.apache.brooklyn.util.core.task.ssh.SshTasks;
    +import org.apache.brooklyn.util.core.task.system.ProcessTaskWrapper;
    +import org.apache.brooklyn.util.exceptions.Exceptions;
    +import org.apache.brooklyn.util.text.Identifiers;
    +import org.apache.brooklyn.util.text.Strings;
    +import org.apache.brooklyn.util.time.Duration;
    +import org.slf4j.Logger;
    +import org.slf4j.LoggerFactory;
    +
    +import com.google.common.base.Joiner;
    +import com.google.common.base.Splitter;
    +import com.google.common.base.Suppliers;
    +import com.google.common.collect.ImmutableList;
    +import com.google.common.collect.ImmutableMap;
    +import com.google.common.collect.Iterables;
    +
    +// TODO assertions below should use TestFrameworkAssertions but that class needs to be improved to give better error messages
    +public class TestSshCommandImpl extends TargetableTestComponentImpl implements TestSshCommand {
    +
    +    private static final Logger LOG = LoggerFactory.getLogger(TestSshCommandImpl.class);
    +    private static final int A_LINE = 80;
    +    public static final String DEFAULT_NAME = "download.sh";
    +    private static final String CD = "cd";
    +
    +    @Override
    +    public void start(Collection<? extends Location> locations) {
    +        setExpectedState(this, STARTING);
    +        execute();
    +    }
    +
    +    @Override
    +    public void stop() {
    +        LOG.debug("{} Stopping simple command", this);
    +        setUpAndRunState(false, STOPPED);
    +    }
    +
    +    @Override
    +    public void restart() {
    +        LOG.debug("{} Restarting simple command", this);
    +        execute();
    +    }
    +
    +    private void setUpAndRunState(boolean up, Lifecycle status) {
    +        sensors().set(SERVICE_UP, up);
    +        setExpectedState(this, status);
    +    }
    +
    +    private static class Result {
    +        int exitCode;
    +        String stdout;
    +        String stderr;
    +        public Result(final ProcessTaskWrapper<Integer> job) {
    +            exitCode = job.get();
    +            stdout = job.getStdout().trim();
    +            stderr = job.getStderr().trim();
    +        }
    +        public int getExitCode() {
    +            return exitCode;
    +        }
    +        public String getStdout() {
    +            return stdout;
    +        }
    +        public String getStderr() {
    +            return stderr;
    +        }
    +    }
    +
    +    protected void handle(Result result) {
    +        LOG.debug("{}, Result is {}\nwith output [\n{}\n] and error [\n{}\n]", new Object[] {
    +            this, result.getExitCode(), shorten(result.getStdout()), shorten(result.getStderr())
    +        });
    +        ImmutableMap<String, Duration> flags = ImmutableMap.of("timeout", getConfig(TIMEOUT));
    +        AssertionSupport support = new AssertionSupport();
    +        checkAssertions(support, flags, exitCodeAssertions(), "exit code", Suppliers.ofInstance(result.getExitCode()));
    +        checkAssertions(support, flags, getAssertions(this, ASSERT_OUT), "stdout", Suppliers.ofInstance(result.getStdout()));
    +        checkAssertions(support, flags, getAssertions(this, ASSERT_ERR), "stderr", Suppliers.ofInstance(result.getStderr()));
    +        support.validate();
    +    }
    +
    +    private String shorten(String text) {
    +        return Strings.maxlenWithEllipsis(text, A_LINE);
    +    }
    +
    +    public void execute() {
    +        try {
    +            SshMachineLocation machineLocation =
    +                Machines.findUniqueMachineLocation(resolveTarget().getLocations(), SshMachineLocation.class).get();
    +            executeCommand(machineLocation);
    +            setUpAndRunState(true, RUNNING);
    +        } catch (Throwable t) {
    +            setUpAndRunState(false, ON_FIRE);
    +            throw Exceptions.propagate(t);
    +        }
    +    }
    +
    +    private void executeCommand(SshMachineLocation machineLocation) {
    +
    +        Result result = null;
    +        String downloadUrl = getConfig(DOWNLOAD_URL);
    +        String command = getConfig(COMMAND);
    +
    +        String downloadName = DOWNLOAD_URL.getName();
    +        String commandName = COMMAND.getName();
    +
    +        Map<String, Object> env = getConfig(SHELL_ENVIRONMENT);
    +        if (env == null) env = ImmutableMap.of();
    +        
    +        if (!(isNonBlank(downloadUrl) ^ isNonBlank(command))) {
    +            throw illegal("Must specify exactly one of", downloadName, "and", commandName);
    +        }
    +
    +        if (isNonBlank(downloadUrl)) {
    +            String scriptDir = getConfig(SCRIPT_DIR);
    +            String scriptPath = calculateDestPath(downloadUrl, scriptDir);
    +            result = executeDownloadedScript(machineLocation, downloadUrl, scriptPath, env);
    +        }
    +
    +        if (isNonBlank(command)) {
    +            result = executeShellCommand(machineLocation, command, env);
    +        }
    +
    +        handle(result);
    +    }
    +
    +    private Result executeDownloadedScript(SshMachineLocation machineLocation, String url, String scriptPath, Map<String, Object> env) {
    +
    +        TaskFactory<?> install = SshTasks.installFromUrl(ImmutableMap.<String, Object>of(), machineLocation, url, scriptPath);
    +        DynamicTasks.queue(install);
    +        DynamicTasks.waitForLast();
    +
    +        List<String> commands = ImmutableList.<String>builder()
    +                .add("chmod u+x " + scriptPath)
    +                .addAll(maybeCdToRunDirCmd())
    +                .add(scriptPath)
    +                .build();
    +
    +        return runCommands(machineLocation, commands, env);
    +    }
    +
    +    private Result executeShellCommand(SshMachineLocation machineLocation, String command, Map<String, Object> env) {
    +
    +        List<String> commands = ImmutableList.<String>builder()
    +                .addAll(maybeCdToRunDirCmd())
    +                .add(command)
    +                .build();
    +
    +        return runCommands(machineLocation, commands, env);
    +    }
    +
    +    private List<String> maybeCdToRunDirCmd() {
    +        String runDir = getConfig(RUN_DIR);
    +        if (!isBlank(runDir)) {
    +            return ImmutableList.of(CD + " " + runDir);
    +        } else {
    +            return ImmutableList.of();
    +        }
    +    }
    +
    +    private Result runCommands(SshMachineLocation machine, List<String> commands, Map<String, Object> env) {
    +        @SuppressWarnings({ "unchecked", "rawtypes" })
    +        SshEffectorTasks.SshEffectorTaskFactory<Integer> etf = SshEffectorTasks.ssh(commands.toArray(new String[]{}))
    +                .environmentVariables((Map<String, String>)(Map)env)
    +                .machine(machine);
    +
    +        ProcessTaskWrapper<Integer> job = DynamicTasks.queue(etf);
    +        job.asTask().blockUntilEnded();
    +        return new Result(job);
    +    }
    +
    +
    +
    +    private IllegalArgumentException illegal(String message, String... messages) {
    +        Iterable<String> allmsgs = Iterables.concat(MutableList.of(this.toString() + ":", message), Arrays.asList(messages));
    --- End diff --
    
    There were previously generics warnings. I *think* what would happen before with `Joiner.on(' ').join(this.toString() + ":", message, messages)` is that it would give you a joined the iterable of `[toString()+":", message, messages]` (i.e. it would have called `messages.toString()` rather than concatenating the contents of that array with the others. You get away with that because the toString is ok. You'd just get some extra square brackets in the result.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---