/ - Diff - EDIT - EDIT Project Management

« Previous | Next »

Revision 87eea6d6

Added by Andreas Kohlbecker over 3 years ago

ID 87eea6d6b5d2610da1f61451206eba053493d486
Parent bcc70074
Child 09762fde

ref #9188 more robust and efficient DrushExecuter

     import java.net.URI;
     import eu.etaxonomy.drush.DrushExecuter;
     import eu.etaxonomy.drush.DrushExecutionFailure;
     /**
+     *
-...
             return pageHeader + " | " + getSiteName();
+        }
         public DrushExecuter drushExecuter() throws IOException, InterruptedException {
         public DrushExecuter drushExecuter() throws IOException, InterruptedException, DrushExecutionFailure {
             DrushExecuter dex = new DrushExecuter();
             dex.setDrupalRoot(drupalRoot);
             dex.setSiteURI(siteUri);

     import eu.etaxonomy.dataportal.DrupalVars;
     import eu.etaxonomy.dataportal.selenium.WebDriverFactory;
     import eu.etaxonomy.drush.DrushExecuter;
     import eu.etaxonomy.drush.DrushExecutionFailure;
     /**
      * @author a.kohlbecker
-...
+    	}
     	@After
         public void resetToOriginalState() throws IOException, InterruptedException {
         public void resetToOriginalState() throws IOException, InterruptedException, DrushExecutionFailure {
             restoreOriginalVars();
+        }
-...
+         *
          * @throws IOException
          * @throws InterruptedException
          * @throws DrushExecutionFailure
          */
         protected void setDrupalVar(String varKey, String varValue) throws IOException, InterruptedException {
         protected void setDrupalVar(String varKey, String varValue) throws IOException, InterruptedException, DrushExecutionFailure {
             DrushExecuter dex = getContext().drushExecuter();
             List<Object> result = dex.execute(DrushExecuter.variableGet, varKey);
             assertEquals(1, result.size());
-...
                 drupalVarsBeforeTest.put(varKey, result.get(0));
+            }
             result = dex.execute(DrushExecuter.variableSet, varKey, varValue);
             assertEquals("success", result.get(1));
+        }
         protected void restoreOriginalVars() throws IOException, InterruptedException {
         protected void restoreOriginalVars() throws IOException, InterruptedException, DrushExecutionFailure {
             DrushExecuter dex = getContext().drushExecuter();
             boolean fail = false;
             for(String varKey : drupalVarsBeforeTest.keySet()) {
                 try {
                     List<Object> result = dex.execute(DrushExecuter.variableSet, varKey, drupalVarsBeforeTest.get(varKey).toString());
                     assertEquals("success", result.get(1));
                 } catch (Exception e) {
                     logger.error("FATAL ERROR: Restoring the original drupal variable " + varKey + " = " + drupalVarsBeforeTest.get(varKey) + " failed.", e);
                     fail = true;

     import java.util.Scanner;
     import java.util.regex.Matcher;
     import java.util.regex.Pattern;
     import java.util.stream.Collectors;
     import org.apache.commons.io.IOUtils;
     import org.apache.commons.lang3.SystemUtils;
-...
         private String sshHost = null;
         public DrushExecuter() throws IOException, InterruptedException {
         public DrushExecuter() throws IOException, InterruptedException, DrushExecutionFailure {
             findDrushCommand();
+        }
         /**
          * The execution of this command via
          * <code>DrushExecuter.execute({@linkplain DrushCommand#version})</code> results in
          * <code>DrushExecuter.execute({@linkplain #version})</code> results in
          * a {@code List<String>} return variable with the following elements:
+         *
          * <ol>
-...
          * Executes {@code drush vget --exact <variable-key>}
          * <p>
          * The execution of this command via
          * <code>DrushExecuter.execute({@linkplain DrushCommand#variableSet})</code> results in
          * <code>DrushExecuter.execute({@linkplain DrushExecuter#variableSet})</code> results in
          * a {@code List<String>} return variable with the following elements:
+         *
          * <ol>
-...
          * <li>value</li>
          * <ol>
          */
         public static DrushCommand variableGet = new DrushCommand(Arrays.asList("vget", "--exact", "--format=json", "%s"));
         public static DrushCommand variableGet = new DrushCommand(Arrays.asList("vget", "--exact", "--format=json", "%s"), true);
         /**
          * Executes {@code drush vset --exact <variable-key> <variable-value>}
          * <p>
          * The execution of this command via
          * <code>DrushExecuter.execute({@linkplain DrushCommand#variableSet})</code> results in
          * a {@code List<String>} return variable with the following elements:
+         *
          * <ol>
          * <li>value</li>
          * <li>status</li>
          * <ol>
          * <code>DrushExecuter.execute({@linkplain DrushExecuter#variableSet})</code> will not return any values.
          * The command will fail with an {@link DrushExecutionFailure} if setting the variable was not successful.
          */
         public static DrushCommand variableSet = new DrushCommand(Arrays.asList("--yes", "vset", "%s", "%s"), null,
                 ".*set\\sto*(.*)\\..*\\[(\\w+)\\]"
                 );
         public static DrushCommand variableSet = new DrushCommand(Arrays.asList("--yes", "vset", "%s", "%s"), false);
         /**
          * @throws IOException
          *             if an I/O error occurs in the ProcessBuilder
          * @throws InterruptedException
          *             if the Process was interrupted
          * @throws DrushExecutionFailure
          *              if the drush command execution fails with an error code
          */
         private void findDrushCommand() throws IOException, InterruptedException {
         private void findDrushCommand() throws IOException, InterruptedException, DrushExecutionFailure {
             if (SystemUtils.IS_OS_WINDOWS) {
                 throw new RuntimeException("not yet implmented for Windows");
+            }
             List<Object> matches = execute(version);
             assert !((String) matches.get(0)).isEmpty() : "No suitable drush command found in the system";
             String majorVersion = (String) matches.get(0);
             if (Integer.valueOf(majorVersion) < 8) {
             if(DrushCommand.majorVersion == null) {
                 List<Object> matches = execute(version);
                 DrushCommand.majorVersion = (String) matches.get(0);
                 DrushCommand.minorVersion = (String) matches.get(1);
                 DrushCommand.patchLevel = (String) matches.get(2);
+            }
             if(DrushCommand.majorVersion.isEmpty()) {
                 throw new RuntimeException("No suitable drush command found in the system");
+            }
             if (Integer.valueOf(DrushCommand.majorVersion) < 8) {
                 throw new RuntimeException("drush version >= 8 required");
+            }
+        }
         public String drushVersion() {
             return DrushCommand.majorVersion + "." + DrushCommand.minorVersion + "." + DrushCommand.patchLevel;
+        }
         /**
-...
          *             if an I/O error occurs in the ProcessBuilder
          * @throws InterruptedException
          *             if the Process was interrupted
          * @throws DrushExecutionFailure
          *              if the drush command execution fails with an error code
          */
         public List<Object> execute(DrushCommand cmd, String... value) throws IOException, InterruptedException {
         public List<Object> execute(DrushCommand cmd, String... value) throws IOException, InterruptedException, DrushExecutionFailure {
             List<String> executableWithArgs = new ArrayList<>();
-...
                     logger.error(error);
+                }
             } else {
                 throw new RuntimeException(IOUtils.toString(process.getErrorStream()));
                 throw new DrushExecutionFailure(
                         executableWithArgs,
                         IOUtils.toString(process.getInputStream()),
                         IOUtils.toString(process.getErrorStream())
                         );
+            }
             return matches;
+        }
-...
                     if (out == null) {
                         break;
+                    }
                     if (out != null) {
                         Matcher m = regex.matcher(out);
                         int patternMatchCount = 0;
                         while (m.find()) {
                             patternMatchCount++;
                             if (m.groupCount() > 0) {
                                 for (int g = 1; g <= m.groupCount(); g++) {
                                     matches.add(m.group(g));
                                     logger.debug("match[" + patternMatchCount + "." + g + "]: " + m.group(g));
+                                }
                             } else {
                                 matches.add(m.group(0));
                                 logger.debug("entire pattern match[" + patternMatchCount + ".0]: " + m.group(0));
                     Matcher m = regex.matcher(out);
                     int patternMatchCount = 0;
                     while (m.find()) {
                         patternMatchCount++;
                         if (m.groupCount() > 0) {
                             for (int g = 1; g <= m.groupCount(); g++) {
                                 matches.add(m.group(g));
                                 logger.debug("match[" + patternMatchCount + "." + g + "]: " + m.group(g));
+                            }
                         } else {
                             matches.add(m.group(0));
                             logger.debug("entire pattern match[" + patternMatchCount + ".0]: " + m.group(0));
+                        }
+                    }
+                }
-...
+        }
         /**
          * @param matches
          * @param stream
          * @return depending on the drupal variable type different return types are possible:
          *  <ul>
          *  <li>Object</li>
-...
          *  <li>Double</li>
          *  <li>Integer</li>
          *  </ul>
+         *
          * @throws IOException
          */
         protected String readExecutionResponse(List<Object> matches, InputStream stream) throws IOException {
             String out = IOUtils.toString(stream);
-...
         public static class DrushCommand {
             private static String majorVersion;
             private static String minorVersion;
             private static String patchLevel;
             Pattern outRegex;
             Pattern errRegex;
             boolean jsonResult = false;
             boolean failOnError = false;
             List<String> args = new ArrayList<>();
             /**
              * For drush commands not supporting output formatting.
+             *
              * @param args
              *            the command arguments
              * @param outRegex
              *            Regular expression to parse the error stream, capture
              *            groups will be put into the <code>List</code> of strings
              *            returned by
              *            {@link DrushExecuter#execute(DrushCommand, String...)}
              * @param errRegex
              *            Regular expression to parse the error stream, capture
              *            groups will be put into the <code>List</code> of strings
              *            returned by
              *            {@link DrushExecuter#execute(DrushCommand, String...)}
              */
             public DrushCommand(List<String> args, String outRegex, String errRegex) {
                 this.args = args;
                 if (outRegex != null) {
-...
+            }
             /**
              * For drush commands suopporting the {@code --format=json} option.
              * For drush commands which don't require return value parsing by regex or
              * which support the {@code --format=json} option to return structured data.
+             *
              * @param args
              *            the command arguments
              */
             public DrushCommand(List<String> args) {
             public DrushCommand(List<String> args, boolean jsonResult) {
                 this.args = args;
                 this.jsonResult = true;
                 this.jsonResult = jsonResult;
+            }
             public String commandLineString() {
                 return args.stream().collect(Collectors.joining(" "));
+            }
+        }
         /**
-...
          * it too much dependent from the local environment. Once the
          * <code>DrushExecuter</code> is being used in the selenium test suite will
          * be tested implicitly anyway.
+         *
          * @throws DrushExecutionFailure
          *              if the drush command execution fails with an error code
          */
         public static void main(String[] args) throws URISyntaxException {
         public static void main(String[] args) throws URISyntaxException, DrushExecutionFailure {
             DrushExecuter.logger.setLevel(Level.DEBUG);
             try {
                 DrushExecuter dex = new DrushExecuter();
-...
     //            dex.execute(help);
                 results = dex.execute(variableSet, "cdm_webservice_url",
                         "http://api.cybertaxonomy.org/cyprus/");
                 results = dex.execute(variableGet, "cdm_webservice_url");
                 if (!results.get(0).equals("http://api.cybertaxonomy.org/cyprus/")) {
                     throw new RuntimeException("unexpected result item 0: " + results.get(0));
+                }
                 if (!results.get(1).equals("success")) {
                     throw new RuntimeException("unexpected result item 1: " + results.get(0));
                 // test for command failure:
                 DrushExecutionFailure expectedFailure = null;
                 try {
                     dex.setDrupalRoot(new File("/home/andreas/workspaces/www/invalid-folder"));
                     results = dex.execute(variableGet, "cdm_webservice_url");
                 } catch(DrushExecutionFailure e) {
                     expectedFailure = e;
+                }
                 results = dex.execute(variableGet, "cdm_webservice_url");
                 if (!results.get(0).equals("http://api.cybertaxonomy.org/cyprus/")) {
                     throw new RuntimeException("unexpected result item 0: " + results.get(0));
                 if(expectedFailure == null) {
                     throw new AssertionError("DrushExecutionFailure expected due to command failure");
                 } else {
                     logger.debug("invalid command has failed as expected");
+                }
                 // testing remote execution via ssh
                 dex.sshHost = "edit-int";

     /**
     * Copyright (C) 2020 EDIT
     * European Distributed Institute of Taxonomy
     * http://www.e-taxonomy.eu
+    *
     * The contents of this file are subject to the Mozilla Public License Version 1.1
     * See LICENSE.TXT at the top of this package for the full license terms.
     */
     package eu.etaxonomy.drush;
     import java.util.List;
     import java.util.stream.Collectors;
     /**
      * @author a.kohlbecker
      * @since Aug 14, 2020
      */
     public class DrushExecutionFailure extends Exception {
         String out, error, commandLineString;
         /**
          * @param cmd
          * @param out
          * @param error
          * @param matches
          */
         public DrushExecutionFailure(List<String> cmd, String out, String error) {
             this.out = out;
             this.error = error;
             this.commandLineString = cmd.stream().collect(Collectors.joining(" "));
+        }
         @Override
         public String getMessage() {
             return "'" + commandLineString + "' failed with '" + error + "'";
+        }
         @Override
         public String getLocalizedMessage() {
             return getMessage();
+        }
         private static final long serialVersionUID = -4840009591742936935L;
+    }

     import eu.etaxonomy.dataportal.junit.DataPortalContextSuite.DataPortalContexts;
     import eu.etaxonomy.dataportal.pages.TaxonPage;
     import eu.etaxonomy.drush.DrushExecuter;
     import eu.etaxonomy.drush.DrushExecutionFailure;
     /**
      * @author a.kohlbecker
-...
         private static final UUID glenodinium_apiculatum_t = UUID.fromString("d245083e-3bda-435f-9bb3-bdc2249ff23c");
         @Before
         public void switchToView() throws IOException, InterruptedException {
         public void switchToView() throws IOException, InterruptedException, DrushExecutionFailure {
             Logger.getLogger(DrushExecuter.class).setLevel(Level.DEBUG);
             setDrupalVar(DrupalVars.CDM_DATAPORTAL_TAXONPAGE_TABS, "1");
             setDrupalVar(DrupalVars.CDM_SPECIMEN_LIST_VIEW_MODE, "derivate_path");

Also available in: Unified diff

Project

General

Profile

EDIT

Revision 87eea6d6

Added by Andreas Kohlbecker over 3 years ago

Project

General

Profile

EDIT

Revision 87eea6d6

Added by Andreas Kohlbecker over 3 years ago

Related issues