├── src ├── main │ ├── resources │ │ ├── META-INF │ │ │ └── spring.factories │ │ └── logback.xml │ └── java │ │ └── com │ │ └── github │ │ └── woostju │ │ └── ansible │ │ ├── Module.java │ │ ├── command │ │ ├── PingCommand.java │ │ ├── CmdCommand.java │ │ ├── ScriptCommand.java │ │ ├── FileCommand.java │ │ ├── GitCommand.java │ │ ├── CopyCommand.java │ │ ├── ResultValueHeader.java │ │ ├── Command.java │ │ └── PlaybookCommand.java │ │ ├── AnsibleInventoryHost.java │ │ ├── ReturnValue.java │ │ ├── util │ │ ├── SystemCommandExecutor.java │ │ └── JsonUtil.java │ │ └── AnsibleClient.java └── test │ └── java │ ├── script.sh │ ├── playbook-unittest-success.yaml │ ├── id_rsa.pub │ ├── id_rsa │ └── com │ └── github │ └── woostju │ └── test │ ├── FileUtil.java │ └── TestAnsibleClient.java ├── README.md ├── pom.xml └── LICENSE /src/main/resources/META-INF/spring.factories: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/test/java/script.sh: -------------------------------------------------------------------------------- 1 | echo '123' 2 | exit 0 -------------------------------------------------------------------------------- /src/test/java/playbook-unittest-success.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: 172.31.31.82 172.31.31.81 3 | tasks: 4 | - name: copyfile 5 | command: echo 'whatever' -------------------------------------------------------------------------------- /src/main/java/com/github/woostju/ansible/Module.java: -------------------------------------------------------------------------------- 1 | package com.github.woostju.ansible; 2 | 3 | /** 4 | * 5 | * ansible module type 6 | * 7 | * @author jameswu 8 | */ 9 | public enum Module { 10 | script, 11 | command, 12 | ping, 13 | copy, 14 | playbook, 15 | git, 16 | ansible_inventory, 17 | file, 18 | get_url, 19 | setup 20 | } 21 | -------------------------------------------------------------------------------- /src/test/java/id_rsa.pub: -------------------------------------------------------------------------------- 1 | ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCGL2saAg2mOdm2c1an/rbVpNxGIZCfxNDgOppwpECE56l4Apu+Wf7teW6UD/6Up12QAej9iUq2IKc8KHGm07NGOCM6FI3KIL1rCvHr4hbeyidVSW6tcRv3bFBm0/ABdNUZgOJ0yWkWtrpYjilOSf13+mcFrx5GYkgoFOCCzRNKjSaA23WpCjLGCxtEE5EfPTctK9ND7BFmd1iADoEKyt1bOUAhGXSLhJREymiTqOdFsMPrJm0ryCpUZykcehBfC5k71nm3xHaE129xDGjHcDnPx2/FxJz7W7cqdIEgvd+JTOzUFu1gKeRwmwKoAGPRCTtX9AS8PrGE77Fl8edeevlT @weitu.mopaas.com -------------------------------------------------------------------------------- /src/main/java/com/github/woostju/ansible/command/PingCommand.java: -------------------------------------------------------------------------------- 1 | package com.github.woostju.ansible.command; 2 | 3 | import java.util.List; 4 | 5 | import com.github.woostju.ansible.Module; 6 | 7 | /** 8 | * Try to connect to host, verify a usable python and return pong on success 9 | *

Get more information from ping module. 10 | * @author jameswu 11 | * 12 | */ 13 | public class PingCommand extends Command{ 14 | 15 | /** 16 | * 17 | * @param hosts target hosts 18 | */ 19 | public PingCommand(List hosts) { 20 | this(hosts, null, null); 21 | } 22 | 23 | public PingCommand(List hosts, List moduleArgs, List options) { 24 | super(hosts, Module.ping.toString(), moduleArgs, options); 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /src/main/resources/logback.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | %d{HH:mm:ss.SSS} [%X{trace-id}] %-5level %logger{36} - %msg%n 9 | 10 | 11 | 12 | debug 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /src/main/java/com/github/woostju/ansible/command/CmdCommand.java: -------------------------------------------------------------------------------- 1 | package com.github.woostju.ansible.command; 2 | 3 | import java.util.List; 4 | 5 | import org.assertj.core.util.Lists; 6 | import com.github.woostju.ansible.Module; 7 | 8 | /** 9 | * 10 | * The command will be executed on hosts. 11 | *

Get more information from command module 12 | * @author jameswu 13 | * 14 | */ 15 | public class CmdCommand extends Command{ 16 | 17 | 18 | public CmdCommand(List hosts, List moduleArgs,List options) { 19 | super(hosts, Module.command.toString(), moduleArgs, options); 20 | } 21 | 22 | /** 23 | * Execute commands on targets 24 | * @param hosts target hosts 25 | * @param command The command to run. 26 | */ 27 | public CmdCommand(List hosts, String command) { 28 | this(hosts, Lists.newArrayList(command), null); 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /src/main/java/com/github/woostju/ansible/command/ScriptCommand.java: -------------------------------------------------------------------------------- 1 | package com.github.woostju.ansible.command; 2 | 3 | import java.util.List; 4 | 5 | import org.assertj.core.util.Lists; 6 | 7 | import com.github.woostju.ansible.Module; 8 | 9 | /** 10 | * 11 | * Runs a local script on a remote node after transferring it 12 | *

Get more information from script module. 13 | * @author jameswu 14 | * 15 | */ 16 | public class ScriptCommand extends Command{ 17 | 18 | 19 | public ScriptCommand(List hosts, List module_args, List options) { 20 | super(hosts, Module.script.toString(), module_args, options); 21 | } 22 | 23 | /** 24 | * 25 | * @param hosts target hosts 26 | * @param scriptFilePath Path to the script on server to run followed by optional arguments. 27 | * @param executablePath Name or path of a executable to invoke the script with. 28 | */ 29 | public ScriptCommand(List hosts, String scriptFilePath, String executablePath) { 30 | this(hosts, Lists.newArrayList(scriptFilePath, "executable="+executablePath), null); 31 | } 32 | 33 | } 34 | -------------------------------------------------------------------------------- /src/main/java/com/github/woostju/ansible/command/FileCommand.java: -------------------------------------------------------------------------------- 1 | package com.github.woostju.ansible.command; 2 | 3 | import java.util.List; 4 | 5 | import org.assertj.core.util.Lists; 6 | 7 | import com.github.woostju.ansible.Module; 8 | 9 | /** 10 | * Manage files and file properties 11 | *

Get more information from file module. 12 | * @author jameswu 13 | * 14 | */ 15 | public class FileCommand extends Command{ 16 | 17 | public FileCommand(List hosts, List module_args, List options) { 18 | super(hosts, Module.file.toString(), module_args, options); 19 | } 20 | 21 | /** 22 | * 23 | * @param hosts target hosts 24 | * @param path Path to the file being managed. 25 | * @param state Choices: absent directory file hard link touch 26 | */ 27 | public FileCommand(List hosts, String path, FileCommandState state) { 28 | this(hosts, Lists.newArrayList(), null); 29 | this.getModuleArgs().add("path="+path); 30 | this.getModuleArgs().add("state="+state.toString()); 31 | } 32 | 33 | public static enum FileCommandState{ 34 | absent, 35 | directory, 36 | file, 37 | hard, 38 | link, 39 | touch 40 | } 41 | 42 | } 43 | -------------------------------------------------------------------------------- /src/main/java/com/github/woostju/ansible/command/GitCommand.java: -------------------------------------------------------------------------------- 1 | package com.github.woostju.ansible.command; 2 | 3 | import java.util.List; 4 | 5 | import org.assertj.core.util.Lists; 6 | 7 | import com.github.woostju.ansible.Module; 8 | 9 | /** 10 | * Deploy software (or files) from git checkouts 11 | *

Get more information from git module. 12 | * @author jameswu 13 | * 14 | */ 15 | public class GitCommand extends Command{ 16 | 17 | public GitCommand(List hosts, List module_args, List options) { 18 | super(hosts, Module.git.toString(), module_args, options); 19 | } 20 | 21 | /** 22 | * 23 | * @param hosts target hosts 24 | * @param gitRepo git, SSH, or HTTP(S) protocol address of the git repository. 25 | * @param destDirectory The path of where the repository should be checked out. 26 | * @param gitSshKeyFilePath Key file of ssh repository 27 | */ 28 | public GitCommand(List hosts, String gitRepo, String destDirectory, String gitSshKeyFilePath) { 29 | this(hosts, Lists.newArrayList(), null); 30 | this.getModuleArgs().add("force=yes"); 31 | if (gitSshKeyFilePath!=null) { 32 | this.getModuleArgs().add("key_file="+gitSshKeyFilePath); 33 | } 34 | if(gitRepo!=null) { 35 | this.getModuleArgs().add("repo="+gitRepo); 36 | } 37 | if (destDirectory!=null) { 38 | this.getModuleArgs().add("dest="+destDirectory); 39 | } 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /src/main/java/com/github/woostju/ansible/command/CopyCommand.java: -------------------------------------------------------------------------------- 1 | package com.github.woostju.ansible.command; 2 | 3 | import java.util.List; 4 | 5 | import org.assertj.core.util.Lists; 6 | 7 | import com.github.woostju.ansible.Module; 8 | 9 | /** 10 | * 11 | * Copies a file from the local or remote machine to a location on the remote machine. 12 | *

Get more information from copy module. 13 | * @author jameswu 14 | * 15 | */ 16 | public class CopyCommand extends Command{ 17 | 18 | public CopyCommand(List hosts, List module_args, List options) { 19 | super(hosts, Module.copy.toString(), module_args, options); 20 | } 21 | 22 | 23 | /** 24 | * @param hosts the destination 25 | * @param srcPath Path on server to a file to copy to the remote server. 26 | * @param destPath Remote absolute path where the file should be copied to. 27 | * @param force Influence whether the remote file must always be replaced. 28 | * @param owner Name of the user that should own the file/directory, as would be fed to chown. 29 | * @param mode The permissions of the destination file or directory. 30 | */ 31 | public CopyCommand(List hosts, String srcPath, String destPath, Boolean force, String owner, String mode) { 32 | this(hosts, Lists.newArrayList(), null); 33 | this.getModuleArgs().add("src="+srcPath); 34 | this.getModuleArgs().add("dest="+destPath); 35 | if (mode!=null) { 36 | this.getModuleArgs().add("mode="+mode); 37 | } 38 | if (owner!=null) { 39 | this.getModuleArgs().add("owner="+owner); 40 | } 41 | if (force!=null) { 42 | this.getModuleArgs().add("force="+ (force?"yes":"no")); 43 | } 44 | } 45 | } 46 | 47 | 48 | -------------------------------------------------------------------------------- /src/test/java/id_rsa: -------------------------------------------------------------------------------- 1 | -----BEGIN RSA PRIVATE KEY----- 2 | MIIEogIBAAKCAQEAhi9rGgINpjnZtnNWp/621aTcRiGQn8TQ4DqacKRAhOepeAKb 3 | vln+7XlulA/+lKddkAHo/YlKtiCnPChxptOzRjgjOhSNyiC9awrx6+IW3sonVUlu 4 | rXEb92xQZtPwAXTVGYDidMlpFra6WI4pTkn9d/pnBa8eRmJIKBTggs0TSo0mgNt1 5 | qQoyxgsbRBORHz03LSvTQ+wRZndYgA6BCsrdWzlAIRl0i4SURMpok6jnRbDD6yZt 6 | K8gqVGcpHHoQXwuZO9Z5t8R2hNdvcQxox3A5z8dvxcSc+1u3KnSBIL3fiUzs1Bbt 7 | YCnkcJsCqABj0Qk7V/QEvD6xhO+xZfHnXnr5UwIDAQABAoIBAFkU2dFmU5FrDnHl 8 | mD3nB5JF5EZauhyXGOQDg8wL/xk8gnE9qg9wx6D34MVC6QvfIGoeGoNWxdarTtrN 9 | LsZF/No9IoXIZ2ks2xNZLMogSnaVVg90tJlIYfycV7QsN0WAPoiz26MUo0OFA6kO 10 | l7V1wWQJRKOtYjfvv198nJ+5bXkryGuD66xNgAy6TRSbsguaGvcOWvdXXW0YDu/q 11 | o7Xut+l5rPUR8+lVODw23Wq4ecGHtits/lwh1he5Z3kwiCtBH9J1Vkh6CILITfpD 12 | XvUi5Y/V+Zpdqf1dkUJKZGr+eRDdzLaTuKb253lbPGo1cNE7InbhV9Q4bdJnx+EM 13 | ptvfJWECgYEA4+JKPAHE7YIChphBAbIkffRZyJ+L+S137DMNOqxur/jptOMMxJtL 14 | wsC8adKhp4OcC93zE17816afRnVW+tNLY0+ebve5j0SUdvbmBPxj/Z5JwXOmFeBG 15 | GBB7ENTc0Wf9uMdTso958danOaWhvHCpCVTHMlo36tzpwYvzMv3lDfUCgYEAlr2n 16 | /TxE/G68ws7W4BB1WIGP6tXJe9721Q8quUqBSFTcxL962mC3hsfp+cFMs2DSa4qa 17 | 09/DVMmyhPz++Ntde6N2bmn+VE/EV85Ud0ckRd/A5Bkqq5GRGVMBAFP1XceM1aUn 18 | r32JnersYm5pgnTaLwj3TwsbW582GfnV/O911ScCgYAd0DciDqEy6XVnInguvp2j 19 | lNpCMw1e9iHgVvV+HZ0FjK0WqzW6aw7IVerQdWwMvF0n+Eua1yyBEh14XFWazxXn 20 | 0jzKC8LNCY3a2oZRVKvIPHMtyfGKnyLMdyuCkjapds9s4zcB/19W0lxiYFb+jkav 21 | H9ZHsiHqqigy2BpjK3BSGQKBgH0qihz6OIYrJU3VFhMDV4zgODJUxnK21tpfN6iX 22 | tvXqkU5FeKtv97RQt3WNDjU8RjzJ4HnhqX3z5OoMcWMOM3eAacyQ8n/rpCsMxpIs 23 | XnAutSoxw36m5obSp1gwXuM52TVlZ6iOYwDfmty4tZ9/i9PWbBQUMulHMFMtYoQe 24 | CgetAoGAHCpqFcZAnLFCLxRr0+O20DORAVHUJSNJphOjb2UdTLM7jVY+Ns5nBbiB 25 | AzKutcHou34gtqazHFRlGz3jw3cOKqMTdu4Fj3JQroVgWPT0eQRfCHzbj4ET9yeF 26 | LTNMRj/KLbDaLBYEXEhR4ezNIlPJOUdVugZaxa9UUG6mqD6FMWY= 27 | -----END RSA PRIVATE KEY----- 28 | -------------------------------------------------------------------------------- /src/main/java/com/github/woostju/ansible/AnsibleInventoryHost.java: -------------------------------------------------------------------------------- 1 | package com.github.woostju.ansible; 2 | 3 | public class AnsibleInventoryHost { 4 | 5 | private String host_name; 6 | 7 | private String ansible_port; 8 | 9 | private String ansible_user; 10 | 11 | private String ansible_ssh_private_key_file; 12 | 13 | private String ansible_ssh_pass; 14 | 15 | private String ansible_become_password; 16 | 17 | private String ansible_become; 18 | 19 | public String getHost_name() { 20 | return host_name; 21 | } 22 | 23 | public void setHost_name(String host_name) { 24 | this.host_name = host_name; 25 | } 26 | 27 | public String getAnsible_port() { 28 | return ansible_port; 29 | } 30 | 31 | public void setAnsible_port(String ansible_port) { 32 | this.ansible_port = ansible_port; 33 | } 34 | 35 | public String getAnsible_user() { 36 | return ansible_user; 37 | } 38 | 39 | public void setAnsible_user(String ansible_user) { 40 | this.ansible_user = ansible_user; 41 | } 42 | 43 | public String getAnsible_ssh_private_key_file() { 44 | return ansible_ssh_private_key_file; 45 | } 46 | 47 | public void setAnsible_ssh_private_key_file(String ansible_ssh_private_key_file) { 48 | this.ansible_ssh_private_key_file = ansible_ssh_private_key_file; 49 | } 50 | 51 | public String getAnsible_ssh_pass() { 52 | return ansible_ssh_pass; 53 | } 54 | 55 | public void setAnsible_ssh_pass(String ansible_ssh_pass) { 56 | this.ansible_ssh_pass = ansible_ssh_pass; 57 | } 58 | 59 | public String getAnsible_become_password() { 60 | return ansible_become_password; 61 | } 62 | 63 | public void setAnsible_become_password(String ansible_become_password) { 64 | this.ansible_become_password = ansible_become_password; 65 | } 66 | 67 | public String getAnsible_become() { 68 | return ansible_become; 69 | } 70 | 71 | public void setAnsible_become(String ansible_become) { 72 | this.ansible_become = ansible_become; 73 | } 74 | 75 | } 76 | -------------------------------------------------------------------------------- /src/test/java/com/github/woostju/test/FileUtil.java: -------------------------------------------------------------------------------- 1 | package com.github.woostju.test; 2 | 3 | import java.io.File; 4 | import java.io.FileOutputStream; 5 | import java.io.IOException; 6 | 7 | import org.apache.commons.io.IOUtils; 8 | import org.slf4j.Logger; 9 | import org.slf4j.LoggerFactory; 10 | 11 | public class FileUtil { 12 | 13 | private final static Logger logger = LoggerFactory.getLogger(FileUtil.class); 14 | 15 | /** 16 | * 17 | * @param filePath contain folder and filename 18 | * @return folder in filepath 19 | */ 20 | public static String getFolder(String filepath) { 21 | String result = filepath; 22 | result = result.replaceAll("\\\\", "/"); 23 | if (filepath.contains("/")) { 24 | result = filepath.substring(0, filepath.lastIndexOf("/")); 25 | } 26 | return result; 27 | } 28 | 29 | 30 | public static boolean createFile(String fullfilepath, String content, boolean replace) { 31 | if(content==null || content.length()==0){ 32 | logger.error("create file "+fullfilepath+":no content at all"); 33 | return false; 34 | } 35 | //create folder if necessary 36 | String folderPath = getFolder(fullfilepath); 37 | File folder = new File(folderPath); 38 | if(!folder.exists()){ 39 | folder.mkdirs(); 40 | } 41 | File file = new File(fullfilepath); 42 | boolean writeContent = false; 43 | if (!file.exists()) { 44 | try { 45 | file.createNewFile(); 46 | writeContent = true; 47 | } catch (IOException e) { 48 | logger.error("create file "+fullfilepath+" error", e); 49 | return false; 50 | } 51 | }else{ 52 | if(replace){ 53 | writeContent = true; 54 | } 55 | } 56 | if(!writeContent){ 57 | return true; 58 | } 59 | FileOutputStream fileOutputStream = null; 60 | try { 61 | fileOutputStream = new FileOutputStream(file); 62 | if (content != null) { 63 | fileOutputStream.write(content.getBytes("UTF-8")); 64 | } 65 | fileOutputStream.close(); 66 | } catch (Exception e) { 67 | logger.error("create file "+fullfilepath+" error ", e); 68 | return false; 69 | }finally { 70 | IOUtils.closeQuietly(fileOutputStream); 71 | } 72 | return true; 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /src/main/java/com/github/woostju/ansible/ReturnValue.java: -------------------------------------------------------------------------------- 1 | package com.github.woostju.ansible; 2 | 3 | import java.util.ArrayList; 4 | import java.util.List; 5 | import java.util.Map; 6 | 7 | /** 8 | * 9 | * Formatted return value of Ansible command output 10 | * 11 | * @author jameswu 12 | * 13 | */ 14 | public class ReturnValue { 15 | public enum Result { 16 | failed, changed, success, unreachable, unmanaged, unknown 17 | } 18 | 19 | private Result result; 20 | 21 | private int rc; 22 | 23 | private Map value; 24 | 25 | private List stdout = new ArrayList(); 26 | 27 | /** 28 | * 29 | * @return output 30 | */ 31 | public List getStdout() { 32 | return stdout; 33 | } 34 | 35 | /** 36 | * set output 37 | * @param stdout output 38 | */ 39 | public void setStdout(List stdout) { 40 | this.stdout = stdout; 41 | } 42 | 43 | /** 44 | * 45 | * @return return code 46 | */ 47 | public int getRc() { 48 | return rc; 49 | } 50 | 51 | /** 52 | * set return code 53 | * @param rc return code 54 | */ 55 | public void setRc(int rc) { 56 | this.rc = rc; 57 | } 58 | 59 | /** 60 | * 61 | * @return result 62 | */ 63 | public Result getResult() { 64 | return result; 65 | } 66 | 67 | /** 68 | * set result 69 | * @param result result 70 | */ 71 | public void setResult(Result result) { 72 | this.result = result; 73 | } 74 | 75 | 76 | /** 77 | * 78 | * @return json stout to map 79 | */ 80 | public Map getValue() { 81 | return value; 82 | } 83 | 84 | /** 85 | * 86 | * @param value json stout to map 87 | */ 88 | public void setValue(Map value) { 89 | this.value = value; 90 | } 91 | 92 | 93 | /** 94 | * 95 | * @param key key in json 96 | * @return value in json 97 | */ 98 | public Object getValue(String key) { 99 | return this.getValue().get(key); 100 | } 101 | 102 | /** 103 | * @return if result is changed or success, then true, else false 104 | */ 105 | public boolean isSuccess() { 106 | return this.getResult()==Result.changed || this.getResult()==Result.success; 107 | } 108 | 109 | @Override 110 | public String toString() { 111 | return "rc="+rc+" result="+result+" value="+value; 112 | } 113 | 114 | } 115 | -------------------------------------------------------------------------------- /src/main/java/com/github/woostju/ansible/util/SystemCommandExecutor.java: -------------------------------------------------------------------------------- 1 | package com.github.woostju.ansible.util; 2 | 3 | import java.io.BufferedReader; 4 | import java.io.IOException; 5 | import java.io.InputStream; 6 | import java.io.InputStreamReader; 7 | import java.util.ArrayList; 8 | import java.util.List; 9 | import java.util.stream.Collectors; 10 | 11 | import org.assertj.core.util.Lists; 12 | import org.slf4j.Logger; 13 | import org.slf4j.LoggerFactory; 14 | 15 | import net.schmizz.sshj.common.IOUtils; 16 | 17 | /** 18 | * 19 | * @author jameswu 20 | * 21 | * 系统本地进程执行 22 | */ 23 | public class SystemCommandExecutor { 24 | 25 | private final static Logger logger = LoggerFactory.getLogger(SystemCommandExecutor.class); 26 | 27 | boolean stopped = false; 28 | 29 | private SystemCommandExecutor(){ 30 | 31 | } 32 | 33 | public static SystemCommandExecutor newExecutor(){ 34 | return new SystemCommandExecutor(); 35 | } 36 | 37 | public List executeCommand(List command, int timeout) throws IOException { 38 | InputStream inputStream = null; 39 | InputStream errorStream = null; 40 | BufferedReader reader = null; 41 | BufferedReader error_reader = null; 42 | Process process = null; 43 | List stdout = new ArrayList(); 44 | try { 45 | logger.info("execute system command: "+command.stream().collect(Collectors.joining(" "))); 46 | // create the ProcessBuilder and Process 47 | ProcessBuilder pb = new ProcessBuilder(command); 48 | process = pb.start(); 49 | // i'm currently doing these on a separate line here in case i need 50 | // to set them to null 51 | // to get the threads to stop. 52 | // see 53 | // http://java.sun.com/j2se/1.5.0/docs/guide/misc/threadPrimitiveDeprecation.html 54 | inputStream = process.getInputStream(); 55 | errorStream = process.getErrorStream(); 56 | reader = new BufferedReader(new InputStreamReader(inputStream, "UTF-8")); 57 | error_reader = new BufferedReader(new InputStreamReader(errorStream, "UTF-8")); 58 | String outputLine; 59 | while(!stopped && (outputLine = error_reader.readLine())!=null){ 60 | stdout.add(outputLine); 61 | logger.debug(outputLine); 62 | } 63 | while(!stopped && (outputLine = reader.readLine())!=null){ 64 | stdout.add(outputLine); 65 | logger.debug(outputLine); 66 | } 67 | }catch(Exception e) { 68 | logger.error("error execute system command", e); 69 | } 70 | finally { 71 | stopped=true; 72 | IOUtils.closeQuietly(inputStream); 73 | IOUtils.closeQuietly(errorStream); 74 | IOUtils.closeQuietly(reader); 75 | IOUtils.closeQuietly(error_reader); 76 | if(process!=null) { 77 | try { 78 | process.destroyForcibly(); 79 | }catch(Exception e) { 80 | 81 | } 82 | } 83 | } 84 | return stdout; 85 | } 86 | } 87 | -------------------------------------------------------------------------------- /src/main/java/com/github/woostju/ansible/command/ResultValueHeader.java: -------------------------------------------------------------------------------- 1 | package com.github.woostju.ansible.command; 2 | 3 | import java.util.regex.Matcher; 4 | import java.util.regex.Pattern; 5 | 6 | import com.github.woostju.ansible.ReturnValue; 7 | 8 | /** 9 | * 10 | *extract header info for each host, the info contains ip，result，rc 11 | * @author jameswu 12 | */ 13 | public class ResultValueHeader { 14 | // 42.159.4.34 | CHANGED | rc=0 >> 15 | static Pattern head_type1_pattern = Pattern.compile("^\\d+\\.\\d+\\.\\d+\\.\\d+( \\| ).*( \\| ).*>>$"); 16 | 17 | static Pattern head_type1_rc_pattern = Pattern.compile("rc=\\d"); 18 | 19 | static Pattern head_type1_result_pattern = Pattern.compile("( \\| ).*( \\| )"); 20 | // 42.11.11.11 | UNREACHABLE! => { 21 | static Pattern head_type2_pattern = Pattern.compile("^\\d+\\.\\d+\\.\\d+\\.\\d+( \\| ).+=>.*\\{$"); 22 | 23 | static Pattern head_type2_result_pattern = Pattern.compile("( \\| ).*( =>)"); 24 | // the host is not in inventory 25 | static Pattern head_inventory_no_host_pattern = Pattern.compile(".*(Could not match supplied host pattern).*"); 26 | 27 | static Pattern head_ip_pattern = Pattern.compile("\\d+\\.\\d+\\.\\d+\\.\\d+"); 28 | 29 | private String ip; 30 | 31 | private ReturnValue.Result result; 32 | 33 | private Integer rc = -1; 34 | 35 | public String getIp(){ 36 | return ip; 37 | } 38 | 39 | public Integer getRc(){ 40 | return rc; 41 | } 42 | 43 | public ReturnValue.Result getResult(){ 44 | return result; 45 | } 46 | 47 | enum HeaderType{ 48 | type1, 49 | type2, 50 | type_not_in_inventory 51 | } 52 | 53 | /** 54 | * 55 | * @param headerLine header line 56 | * @return a {@link ResultValueHeader}, null if line is not a header 57 | * 58 | */ 59 | public static ResultValueHeader createHeader(String headerLine){ 60 | ResultValueHeader header = new ResultValueHeader(); 61 | HeaderType headerType; 62 | if(head_type1_pattern.matcher(headerLine).matches()){ 63 | headerType = HeaderType.type1; 64 | }else if(head_type2_pattern.matcher(headerLine).matches()){ 65 | headerType = HeaderType.type2; 66 | }else if(head_inventory_no_host_pattern.matcher(headerLine).matches()){ 67 | headerType = HeaderType.type_not_in_inventory; 68 | }else{ 69 | return null; 70 | } 71 | header.parseHeader(headerType, headerLine); 72 | return header; 73 | } 74 | 75 | private void parseHeader(HeaderType headerType, String headerLine){ 76 | // parse ip 77 | Matcher matchIp = head_ip_pattern.matcher(headerLine); 78 | if (matchIp.find()) { 79 | this.ip = matchIp.group(); 80 | } 81 | switch (headerType) { 82 | case type1: 83 | { 84 | // 42.159.4.34 | CHANGED | rc=0 >> 85 | // parse rc code 86 | Matcher matchRc = head_type1_rc_pattern.matcher(headerLine); 87 | if(matchRc.find()){ 88 | String rc = matchRc.group(); 89 | int code = Integer.valueOf(rc.replaceAll("rc=", "")); 90 | this.rc = code; 91 | } 92 | // parse result 93 | Matcher matchResult = head_type1_result_pattern.matcher(headerLine); 94 | if(matchResult.find()){ 95 | String rawResult = matchResult.group(); 96 | this.result = this.transferResult(rawResult.replaceAll("\\|", "").replaceAll(" ", "")); 97 | } 98 | } 99 | break; 100 | case type2:{ 101 | // 42.11.11.11 | UNREACHABLE! => { 102 | Matcher matchResult = head_type2_result_pattern.matcher(headerLine); 103 | if(matchResult.find()){ 104 | String rawResult = matchResult.group(); 105 | this.result = this.transferResult(rawResult.replaceAll("\\|", "").replaceAll(" ", "").replaceAll("=>","")); 106 | } 107 | } 108 | break; 109 | case type_not_in_inventory: 110 | { 111 | // [WARNING]: Could not match supplied host pattern, ignoring: 12.12.12.12 112 | this.result = ReturnValue.Result.unmanaged; 113 | } 114 | break; 115 | default: 116 | break; 117 | } 118 | } 119 | 120 | private ReturnValue.Result transferResult(String result){ 121 | if("CHANGED".equals(result)) { 122 | return ReturnValue.Result.changed; 123 | } 124 | if("SUCCESS".equals(result)) { 125 | return ReturnValue.Result.success; 126 | } 127 | if("UNREACHABLE!".equals(result)) { 128 | return ReturnValue.Result.unreachable; 129 | } 130 | if("FAILED!".equals(result)) { 131 | return ReturnValue.Result.failed; 132 | } 133 | return ReturnValue.Result.unknown; 134 | } 135 | 136 | @Override 137 | public String toString() { 138 | return this.ip + " " + this.rc + " " + this.result; 139 | } 140 | } 141 | -------------------------------------------------------------------------------- /src/main/java/com/github/woostju/ansible/util/JsonUtil.java: -------------------------------------------------------------------------------- 1 | 2 | package com.github.woostju.ansible.util; 3 | 4 | import com.fasterxml.jackson.annotation.JsonInclude.Include; 5 | import com.fasterxml.jackson.core.JsonProcessingException; 6 | import com.fasterxml.jackson.databind.DeserializationFeature; 7 | import com.fasterxml.jackson.databind.ObjectMapper; 8 | import com.fasterxml.jackson.databind.SerializationFeature; 9 | import com.fasterxml.jackson.databind.node.ObjectNode; 10 | 11 | import java.io.IOException; 12 | import java.text.SimpleDateFormat; 13 | import java.util.ArrayList; 14 | import java.util.HashMap; 15 | import java.util.List; 16 | import java.util.Map; 17 | import java.util.TimeZone; 18 | 19 | public class JsonUtil { 20 | 21 | private static final ObjectMapper objectMapper; 22 | 23 | static { 24 | objectMapper = new ObjectMapper(); 25 | objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false); 26 | objectMapper.setTimeZone(TimeZone.getTimeZone("GMT+8")); 27 | objectMapper.configure(SerializationFeature.WRITE_NULL_MAP_VALUES, false); 28 | objectMapper.setSerializationInclusion(Include.NON_NULL); 29 | objectMapper.getDeserializationConfig().withoutFeatures(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES); 30 | objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")); 31 | objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false); 32 | objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); 33 | objectMapper.configure(com.fasterxml.jackson.core.JsonParser.Feature.ALLOW_SINGLE_QUOTES, true); 34 | } 35 | 36 | public static ObjectMapper getObjectMapper() { 37 | return objectMapper; 38 | } 39 | 40 | public static T toObject(Object entity, Class clazz) { 41 | try { 42 | return objectMapper.readValue(objectMapper.writeValueAsString(entity), clazz); 43 | } catch (IOException e) { 44 | throw new RuntimeException(e); 45 | } 46 | } 47 | 48 | public static ObjectNode toObjectNode(Object entity) { 49 | return toObject(entity, ObjectNode.class); 50 | } 51 | 52 | public static T toObject(String json, Class clazz) { 53 | try { 54 | return objectMapper.readValue(json, clazz); 55 | } catch (IOException e) { 56 | throw new RuntimeException(e); 57 | } 58 | } 59 | 60 | public static String toJsonString(T entity) { 61 | try { 62 | return objectMapper.writeValueAsString(entity); 63 | } catch (JsonProcessingException e) { 64 | throw new RuntimeException(e); 65 | } 66 | } 67 | 68 | public static List toArray(String json, Class clazz) { 69 | try { 70 | return objectMapper.readValue(json, objectMapper.getTypeFactory().constructCollectionType(ArrayList.class, clazz)); 71 | } catch (IOException e) { 72 | throw new RuntimeException(e); 73 | } 74 | } 75 | 76 | public static List toArray(Object object, Class clazz) { 77 | try { 78 | return objectMapper.readValue(toJsonString(object), objectMapper.getTypeFactory().constructCollectionType(ArrayList.class, clazz)); 79 | } catch (IOException e) { 80 | throw new RuntimeException(e); 81 | } 82 | } 83 | 84 | public static Map toHashMap(String json, Class keyClass, Class valueClass) { 85 | try { 86 | return objectMapper.readValue(json, objectMapper.getTypeFactory().constructMapType(HashMap.class, keyClass, valueClass)); 87 | } catch (IOException e) { 88 | throw new RuntimeException(e); 89 | } 90 | } 91 | 92 | public static Map toHashMap(Object object, Class keyClass, Class valueClass) { 93 | try { 94 | return objectMapper.readValue(toJsonString(object), objectMapper.getTypeFactory().constructMapType(HashMap.class, keyClass, valueClass)); 95 | } catch (IOException e) { 96 | throw new RuntimeException(e); 97 | } 98 | } 99 | 100 | 101 | public static Map bean2Map(Object bean) { 102 | try { 103 | return (Map) objectMapper.convertValue(bean, Map.class); 104 | } catch (Exception ex) { 105 | ex.printStackTrace(); 106 | } 107 | return null; 108 | } 109 | 110 | public static T map2Bean(Map map, Class clazz) { 111 | return objectMapper.convertValue(map, clazz); 112 | } 113 | 114 | public static boolean isJSONValid(String content) { 115 | try { 116 | objectMapper.readTree(content); 117 | return true; 118 | } catch (IOException e) { 119 | return false; 120 | } 121 | } 122 | 123 | } -------------------------------------------------------------------------------- /src/main/java/com/github/woostju/ansible/command/Command.java: -------------------------------------------------------------------------------- 1 | package com.github.woostju.ansible.command; 2 | 3 | import java.util.ArrayList; 4 | import java.util.HashMap; 5 | import java.util.List; 6 | import java.util.Map; 7 | import java.util.stream.Collectors; 8 | 9 | import com.github.woostju.ansible.AnsibleClient; 10 | import com.github.woostju.ansible.ReturnValue; 11 | import com.github.woostju.ansible.util.JsonUtil; 12 | 13 | /** 14 | * All the Ansible command should extends this command 15 | * @author jameswu 16 | * 17 | */ 18 | public abstract class Command{ 19 | 20 | private List hosts; 21 | 22 | private List moduleArgs; 23 | 24 | private String module; 25 | 26 | private List options; 27 | 28 | public Command() { 29 | 30 | } 31 | 32 | /** 33 | * executable to run command 34 | * @return default return ansible 35 | */ 36 | public String getExecutable() { 37 | return "ansible"; 38 | } 39 | 40 | /** 41 | * create Ansible command line to be sent 42 | * @param client AnsibleClient 43 | * @param command Command 44 | * @return Ansible command line 45 | */ 46 | public List createAnsibleCommands(AnsibleClient client, Command command) { 47 | List commands = new ArrayList<>(); 48 | commands.add(client.getAnsibleRootPath() + command.getExecutable()); 49 | if(client.getInventoryPath()!=null){ 50 | commands.add("-i"); 51 | commands.add(client.getInventoryPath()); 52 | } 53 | commands.add(command.getHosts().stream().collect(Collectors.joining(":"))); 54 | if (command.getModule()!=null) { 55 | commands.add("-m "+command.getModule().toString()); 56 | } 57 | if (null!= command.getModuleArgs() && command.getModuleArgs().size()>0) { 58 | if (client.getHostSshConfig()!=null) { 59 | commands.add("-a '"+command.getModuleArgs().stream().collect(Collectors.joining(" "))+"'"); 60 | }else { 61 | commands.add("-a "+command.getModuleArgs().stream().collect(Collectors.joining(" "))); 62 | } 63 | } 64 | if (null!= command.getOptions() && command.getOptions().size()>0) { 65 | commands.add(command.getOptions().stream().collect(Collectors.joining(" "))); 66 | } 67 | return commands; 68 | } 69 | 70 | /** 71 | * Parse the Ansible output 72 | * @param rawOutput the Ansible output 73 | * @return return value of output, key:ip address, value: {@link ReturnValue} 74 | */ 75 | public Map parseCommandReturnValues(List rawOutput){ 76 | Map returnValues = new HashMap<>(); 77 | String currentKey = null; 78 | for(String line:rawOutput){ 79 | // the line with ip is ResultValueHeader 80 | ResultValueHeader header = ResultValueHeader.createHeader(line); 81 | if(header!=null){ 82 | // a ReturnValue object created for ip 83 | ReturnValue resultValue = new ReturnValue(); 84 | resultValue.setRc(header.getRc()); 85 | resultValue.setResult(header.getResult()); 86 | returnValues.put(header.getIp(), resultValue); 87 | currentKey = header.getIp(); 88 | }else if(currentKey!=null){ 89 | // the line should put into stdout 90 | returnValues.get(currentKey).getStdout().add(line); 91 | } 92 | } 93 | // parse the ReturnValue.stdout to ReturnValue.value 94 | for(String key:returnValues.keySet()){ 95 | ReturnValue returnValue = returnValues.get(key); 96 | if(returnValue.getResult() == ReturnValue.Result.unmanaged){ 97 | returnValue.getStdout().add("[WARNING]: Could not match supplied host pattern, ignoring:"+key); 98 | } else{ 99 | try { 100 | String outputJson = returnValue.getStdout().stream().collect(Collectors.joining()); 101 | returnValue.setValue(JsonUtil.toHashMap("{"+outputJson, String.class, Object.class)); 102 | }catch(Exception e) { 103 | // sometime, the stdout is not a json object, and we ignore it 104 | } 105 | } 106 | } 107 | return returnValues; 108 | } 109 | 110 | /** 111 | * @param hosts target hosts 112 | * @param module module name 113 | * @param moduleArgs arguments of module 114 | * @param options options for Ansible 115 | */ 116 | public Command(List hosts, String module, List moduleArgs, List options){ 117 | this.hosts = hosts; 118 | this.module = module; 119 | this.moduleArgs = moduleArgs; 120 | this.options = options; 121 | } 122 | 123 | public List getHosts() { 124 | return hosts; 125 | } 126 | 127 | public void setHosts(List hosts) { 128 | this.hosts = hosts; 129 | } 130 | 131 | public List getModuleArgs() { 132 | return moduleArgs; 133 | } 134 | 135 | public void setModuleArgs(List moduleArgs) { 136 | this.moduleArgs = moduleArgs; 137 | } 138 | 139 | public String getModule() { 140 | return module; 141 | } 142 | 143 | public void setModule(String module) { 144 | this.module = module; 145 | } 146 | 147 | public List getOptions() { 148 | return options; 149 | } 150 | 151 | public void setOptions(List options) { 152 | this.options = options; 153 | } 154 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ansible-client 2 | A java implemented client connect to Ansible servers through ssh, and run Ansible command. 3 | 4 | ## usage 5 | 6 | ansible-client is available from **Maven Central** 7 | 8 | ```xml 9 | 10 | com.github.woostju 11 | ansible-client 12 | 1.0.0-RELEASE 13 | 14 | ``` 15 | 16 | ### Who is this for? 17 | 18 | Anyone who want to execute commands on your Ansible server in java code, instead of logging into server and execute manually. 19 | 20 | With this, you can build an automation tool yourself working with Ansible in java. 21 | 22 | ### How do I use this? 23 | 24 | Use it in your class: 25 | 26 | ```java 27 | 28 | import com.github.woostju.ssh.SshClientConfig; 29 | import com.github.woostju.ansible.AnsibleClient; 30 | import com.github.woostju.ansible.ReturnValue; 31 | import com.github.woostju.ansible.ReturnValue.Result; 32 | 33 | //--------------------------------------- 34 | 35 | public void execute() { 36 | AnsibleClient client = new AnsibleClient(new SshClientConfig("hostIp", "sshPort", "username", "password", null)); 37 | Map result =client.execute(new PingCommand(Lists.newArrayList(host_inner_ip)), 1000); 38 | } 39 | ``` 40 | 41 | It is recommended to use AnsibleClient with [SshClientPool](https://github.com/woostju/ssh-client-pool), so that ansibleClient borrows sshClient from the pool to execute command, to avoid create ssh connection each time: 42 | 43 | ```java 44 | import com.github.woostju.ssh.SshClientConfig; 45 | import com.github.woostju.ansible.AnsibleClient; 46 | import com.github.woostju.ansible.ReturnValue; 47 | import com.github.woostju.ansible.ReturnValue.Result; 48 | import com.github.woostju.ssh.pool.SshClientsPool; 49 | 50 | //--------------------------------------- 51 | 52 | // inject the auto-configured one 53 | @Autowired 54 | SshClientsPool pool; 55 | 56 | //--------------------------------------- 57 | public void execute() { 58 | AnsibleClient client = new AnsibleClient(new SshClientConfig("hostIp", "sshPort", "username", "password", null), pool); 59 | Map result =client.execute(new PingCommand(Lists.newArrayList(host_inner_ip)), 1000); 60 | } 61 | 62 | ``` 63 | 64 | To get more usage, please refer to the unit test code and java docs. 65 | 66 | ### How does it work? 67 | 68 | AnsibleClient connects to Ansible server with ssh, and sends an Ansible adhoc command to server, and parses the output into ReturnValue. 69 | 70 | ### How many Ansible module does ansible-client support? 71 | 72 | Until this release, ansible-client supports modules below: 73 | 74 | | module name | module class | description | official link | 75 | | :----:| :----: | :----: | :----: | 76 | | command | CmdCommand | The command will be executed on hosts | [link](https://docs.ansible.com/ansible/latest/modules/command_module.html) | 77 | | copy | CopyCommand | Copies a file from the local or remote machine to a location on the remote machine | [link](https://docs.ansible.com/ansible/latest/modules/copy_module.html) | 78 | | file | FileCommand | Manage files and file properties | [link](https://docs.ansible.com/ansible/latest/modules/file_module.html) | 79 | | git | GitCommand | Deploy software (or files) from git checkouts | [link](https://docs.ansible.com/ansible/latest/modules/git_module.html) | 80 | | ping | PingCommand | Try to connect to host, verify a usable python and return pong on success |[link](https://docs.ansible.com/ansible/latest/modules/ping_module.html) | 81 | | playbook | PlaybookCommand | Run playbook with ansible-playbook executable | [link](https://docs.ansible.com/ansible/latest/user_guide/playbooks.html) | 82 | | script | ScriptCommand | Runs a local script on a remote node after transferring it | [link](https://docs.ansible.com/ansible/latest/modules/script_module.html) | 83 | 84 | Since Ansible itself has dozens of modules, you can also define your custom command class to work with AnsibleClient. 85 | 86 | ```java 87 | import java.util.List; 88 | 89 | import com.github.woostju.ansible.Module; 90 | 91 | /** 92 | * Add or remove MSSQL databases from a remote host. 93 | */ 94 | public class Mssql_dbCommand extends Command{ 95 | 96 | /** 97 | * @param hosts target hosts 98 | */ 99 | public Mssql_dbCommand(List hosts, String login_host, String login_password, int login_port, String login_user, String name, String target, String state) { 100 | this(hosts, Lists.newArrayList("login_host="+login_host, 101 | "login_password="+login_password, 102 | "login_port="+login_port, 103 | "login_user="+login_user, 104 | "name="+name, 105 | "target="+target, 106 | "state="+state), null); 107 | } 108 | 109 | public Mssql_dbCommand(List hosts, List moduleArgs, List options) { 110 | super(hosts, Module.ping.toString(), moduleArgs, options); 111 | } 112 | } 113 | 114 | ``` 115 | ## License 116 | 117 | This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0). 118 | 119 | 120 | ## Additional Resources 121 | 122 | * [SshClientPool](https://github.com/woostju/ssh-client-pool) a java implementation of ssh clients object pool with sshj, apache common pool2, expectIt 123 | -------------------------------------------------------------------------------- /src/main/java/com/github/woostju/ansible/command/PlaybookCommand.java: -------------------------------------------------------------------------------- 1 | package com.github.woostju.ansible.command; 2 | 3 | import java.util.ArrayList; 4 | import java.util.HashMap; 5 | import java.util.List; 6 | import java.util.Map; 7 | import java.util.regex.Matcher; 8 | import java.util.regex.Pattern; 9 | import java.util.stream.Collectors; 10 | 11 | import com.github.woostju.ansible.AnsibleClient; 12 | import com.github.woostju.ansible.ReturnValue; 13 | 14 | /** 15 | * Run playbook with ansible-playbook executable 16 | *

sample: ansible-playbook -i inventory playbook.yml 17 | *

Get more info from playbook docs 18 | * @author jameswu 19 | * 20 | */ 21 | public class PlaybookCommand extends Command{ 22 | 23 | private String playbookPath; 24 | 25 | /** 26 | * @param hosts target hosts 27 | * @param playbookPath Playbook file path on ansible server 28 | * @param options options 29 | */ 30 | public PlaybookCommand(List hosts, String playbookPath, List options) { 31 | super(hosts, null, 32 | null, 33 | options); 34 | this.playbookPath = playbookPath; 35 | } 36 | 37 | @Override 38 | public List createAnsibleCommands(AnsibleClient client, Command command) { 39 | List commands = new ArrayList<>(); 40 | commands.add(client.getAnsibleRootPath() + command.getExecutable()); 41 | if(client.getInventoryPath()!=null){ 42 | commands.add("-i"); 43 | commands.add(client.getInventoryPath()); 44 | } 45 | commands.add(this.playbookPath); 46 | if (null!= command.getOptions() && command.getOptions().size()>0) { 47 | commands.add(command.getOptions().stream().collect(Collectors.joining(" "))); 48 | } 49 | return commands; 50 | } 51 | 52 | @Override 53 | public String getExecutable() { 54 | return "ansible-playbook"; 55 | } 56 | 57 | static Pattern play_recap_pattern = Pattern.compile("PLAY RECAP (\\*)*"); 58 | static Pattern unreachable_pattern = Pattern.compile("unreachable=\\d"); 59 | static Pattern failed_pattern = Pattern.compile("failed=\\d"); 60 | static Pattern changed_pattern = Pattern.compile("changed=\\d"); 61 | static Pattern ok_pattern = Pattern.compile("ok=\\d"); 62 | static Pattern digital_pattern = Pattern.compile("\\d"); 63 | 64 | @Override 65 | public Map parseCommandReturnValues(List rawOutput) { 66 | /** 67 | * 先寻找[WARNING]: Could not match supplied host pattern: 192.168.0.3 68 | * 再寻找 PLAY RECAP ********************************************************************* 69 | * 获取每个ip对应的结果 70 | * 输出结果将给到所有的ip 71 | */ 72 | 73 | Pattern ip_pattern = ResultValueHeader.head_ip_pattern; 74 | boolean recap = false; 75 | Map responses = new HashMap<>(); 76 | for(String line : rawOutput){ 77 | if(recap){ 78 | Matcher matchIp = ip_pattern.matcher(line); 79 | if(matchIp.find()){ 80 | String ip = matchIp.group(); 81 | responses.put(ip, new ReturnValue()); 82 | responses.get(ip).setStdout(rawOutput); 83 | Matcher match = failed_pattern.matcher(line); 84 | if(match.find()){ 85 | Matcher match2 = digital_pattern.matcher(match.group()); 86 | if(match2.find()) { 87 | if (Integer.valueOf(match2.group())>0) { 88 | responses.get(ip).setResult(ReturnValue.Result.failed); 89 | continue; 90 | } 91 | } 92 | } 93 | match = unreachable_pattern.matcher(line); 94 | if(match.find()){ 95 | Matcher match2 = digital_pattern.matcher(match.group()); 96 | if(match2.find()) { 97 | if (Integer.valueOf(match2.group())>0) { 98 | responses.get(ip).setResult(ReturnValue.Result.unreachable); 99 | continue; 100 | } 101 | } 102 | } 103 | match = ok_pattern.matcher(line); 104 | if(match.find()){ 105 | Matcher match2 = digital_pattern.matcher(match.group()); 106 | if(match2.find()) { 107 | if (Integer.valueOf(match2.group())>0) { 108 | responses.get(ip).setResult(ReturnValue.Result.success); 109 | continue; 110 | } 111 | } 112 | } 113 | match = changed_pattern.matcher(line); 114 | if(match.find()){ 115 | Matcher match2 = digital_pattern.matcher(match.group()); 116 | if(match2.find()) { 117 | if (Integer.valueOf(match2.group())>0) { 118 | responses.get(ip).setResult(ReturnValue.Result.changed); 119 | continue; } 120 | } 121 | } 122 | } 123 | }else{ 124 | // find any hosts not in inventory 125 | if(line.contains("[WARNING]")){ 126 | Matcher matchNotInInventory = ResultValueHeader.head_inventory_no_host_pattern.matcher(line); 127 | if(matchNotInInventory.matches()){ 128 | Matcher matchIp = ResultValueHeader.head_ip_pattern.matcher(line); 129 | if(matchIp.find()){ 130 | String ip = matchIp.group(); 131 | responses.put(ip, new ReturnValue()); 132 | responses.get(ip).setResult(ReturnValue.Result.unmanaged); 133 | responses.get(ip).setStdout(rawOutput); 134 | } 135 | } 136 | }else if(line.startsWith("PLAY")){ 137 | // find the PLAY RECAP ********************* 138 | if(play_recap_pattern.matcher(line).matches()){ 139 | recap = true; 140 | continue; 141 | } 142 | } 143 | } 144 | } 145 | return responses; 146 | } 147 | 148 | } 149 | -------------------------------------------------------------------------------- /src/main/java/com/github/woostju/ansible/AnsibleClient.java: -------------------------------------------------------------------------------- 1 | package com.github.woostju.ansible; 2 | 3 | import java.io.PrintWriter; 4 | import java.io.StringWriter; 5 | import java.util.HashMap; 6 | import java.util.List; 7 | import java.util.Map; 8 | import java.util.stream.Collectors; 9 | 10 | import org.assertj.core.util.Lists; 11 | import org.slf4j.Logger; 12 | import org.slf4j.LoggerFactory; 13 | 14 | import com.github.woostju.ansible.command.Command; 15 | import com.github.woostju.ansible.util.SystemCommandExecutor; 16 | import com.github.woostju.ssh.SshClientConfig; 17 | import com.github.woostju.ssh.SshResponse; 18 | import com.github.woostju.ssh.exception.SshException; 19 | import com.github.woostju.ssh.pool.SshClientPoolConfig; 20 | import com.github.woostju.ssh.pool.SshClientWrapper; 21 | import com.github.woostju.ssh.pool.SshClientsPool; 22 | 23 | /** 24 | * 25 | * ansible client, execute ansible adhoc command on remote ansible server, or execute on local server 26 | * @author jameswu 27 | * 28 | * 29 | */ 30 | 31 | public class AnsibleClient { 32 | 33 | private final static Logger logger = LoggerFactory.getLogger(AnsibleClient.class); 34 | 35 | private SshClientsPool sshClientsPool; 36 | 37 | /** 38 | * Ansible client to local server 39 | */ 40 | public AnsibleClient(){ 41 | 42 | } 43 | 44 | /** 45 | * Ansible client for remote server 46 | * @param config ssh config of remote machine 47 | */ 48 | public AnsibleClient(SshClientConfig config){ 49 | this.hostSshConfig = config; 50 | } 51 | 52 | /** 53 | * Ansible client for remote server 54 | * @param config ssh config of remote machine 55 | * @param sshClientsPool the pool used to ssh client to remote server 56 | */ 57 | public AnsibleClient(SshClientConfig config, SshClientsPool sshClientsPool){ 58 | this.hostSshConfig = config; 59 | this.sshClientsPool = sshClientsPool; 60 | } 61 | 62 | private SshClientConfig hostSshConfig; 63 | 64 | private String ansibleRootPath = "/usr/bin/"; 65 | 66 | private String inventoryPath = "/etc/ansible/hosts"; 67 | 68 | 69 | /** 70 | * set custom Ansible inventory, default is /etc/ansible/hosts 71 | * @param inventoryPath custom Ansible inventory 72 | * @return AnsibleClient 73 | */ 74 | public AnsibleClient setInventoryPath(String inventoryPath){ 75 | this.inventoryPath = inventoryPath; 76 | return this; 77 | } 78 | 79 | /** 80 | * set Ansible executables root folder, the folder should contain executable ansible | ansible-playbook | ansible-inventory .etc, default is /usr/bin/ 81 | * @param ansibleRootPath the root folder of Ansible executables 82 | * @return AnsibleClient 83 | */ 84 | public AnsibleClient setAnsibleRootPath(String ansibleRootPath) { 85 | this.ansibleRootPath = ansibleRootPath; 86 | return this; 87 | } 88 | 89 | /** 90 | * 91 | * @return Ansible executables root folder 92 | */ 93 | public String getAnsibleRootPath() { 94 | return ansibleRootPath; 95 | } 96 | 97 | /** 98 | * 99 | * @return Ansible inventory path 100 | */ 101 | public String getInventoryPath() { 102 | return inventoryPath; 103 | } 104 | 105 | /** 106 | * 107 | * @return host ssh config of ansible server 108 | */ 109 | public SshClientConfig getHostSshConfig() { 110 | return hostSshConfig; 111 | } 112 | 113 | /** 114 | * execute Ansible command 115 | * @param command the command to be executed 116 | * @param timeoutInSeconds timeout in seconds 117 | * @return return value of executed command, key:ip address, value: {@link ReturnValue} 118 | */ 119 | public Map execute(Command command, int timeoutInSeconds){ 120 | List commands = command.createAnsibleCommands(this, command); 121 | logger.info("execute commands "+ commands+" in "+timeoutInSeconds); 122 | Exception exception = null; 123 | Map responses = new HashMap<>(); 124 | if (this.hostSshConfig==null) { 125 | // execute command locally 126 | try { 127 | List stdout = SystemCommandExecutor.newExecutor().executeCommand(commands, timeoutInSeconds); 128 | responses = command.parseCommandReturnValues(stdout); 129 | } catch (Exception e) { 130 | exception = e; 131 | } 132 | }else{ 133 | // execute command remotely 134 | String commandStr = commands.stream().collect(Collectors.joining(" ")); 135 | try { 136 | SshResponse sshResponse; 137 | if (this.sshClientsPool==null) { 138 | // create ssh client directly 139 | SshClientWrapper wrapper = new SshClientWrapper(this.hostSshConfig, new SshClientPoolConfig()); 140 | try { 141 | wrapper.connect(timeoutInSeconds).auth().startSession(); 142 | sshResponse = wrapper.executeCommand(commandStr, timeoutInSeconds); 143 | } catch (SshException e) { 144 | throw new RuntimeException("create ssh client fail"); 145 | }finally { 146 | wrapper.disconnect(); 147 | } 148 | }else { 149 | // borrow ssh client from pool 150 | SshClientWrapper client = this.sshClientsPool.client(this.hostSshConfig); 151 | sshResponse = client.executeCommand(commandStr, timeoutInSeconds); 152 | } 153 | if(sshResponse.getCode()==0) { 154 | try{ 155 | responses = command.parseCommandReturnValues(sshResponse.getStdout()); 156 | }catch(Exception e){ 157 | logger.error("parse ansible output fail", e); 158 | } 159 | } 160 | exception = sshResponse.getException(); 161 | }catch(Exception e) { 162 | logger.error("exec command fail.",e); 163 | exception = e; 164 | } 165 | } 166 | for(String ip:command.getHosts()){ 167 | if(!responses.containsKey(ip)){ 168 | ReturnValue response = new ReturnValue(); 169 | response.setResult(ReturnValue.Result.failed); 170 | if(exception!=null) { 171 | StringWriter sw = new StringWriter(); 172 | PrintWriter pw = new PrintWriter(sw); 173 | exception.printStackTrace(pw); 174 | response.setStdout(Lists.newArrayList(sw.toString())); 175 | } 176 | } 177 | } 178 | return responses; 179 | } 180 | 181 | } 182 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 4 | 4.0.0 5 | com.github.woostju 6 | ansible-client 7 | jar 8 | 1.0.0-RELEASE 9 | ${project.groupId}:${project.artifactId} 10 | https://github.com/woostju/ansible-client 11 | ansible client with ssh 12 | 13 | 14 | 15 | The Apache Software License, Version 2.0 16 | http://www.apache.org/licenses/LICENSE-2.0.txt 17 | repo 18 | 19 | 20 | 21 | 22 | 23 | James WU 24 | woostju@163.com 25 | 26 | 27 | 28 | 29 | scm:git@github.com:woostju/ansible-client.git 30 | scm:git@github.com:woostju/ansible-client.git 31 | https://github.com/woostju/ansible-client.git 32 | 33 | 34 | 35 | 36 | org.springframework.boot 37 | spring-boot-starter-parent 38 | 1.5.10.RELEASE 39 | 40 | 41 | 42 | UTF-8 43 | UTF-8 44 | 1.8 45 | 46 | 47 | 48 | 49 | org.springframework.boot 50 | spring-boot-starter-test 51 | 52 | 53 | ch.qos.logback 54 | logback-classic 55 | 56 | 57 | com.github.woostju 58 | ssh-client-pool 59 | 1.0.1-RELEASE 60 | 61 | 62 | com.fasterxml.jackson.core 63 | jackson-databind 64 | 65 | 66 | com.fasterxml.jackson.core 67 | jackson-annotations 68 | 69 | 70 | commons-io 71 | commons-io 72 | 2.4 73 | 74 | 75 | 76 | 77 | 78 | 79 | org.apache.maven.plugins 80 | maven-source-plugin 81 | 82 | 83 | attach-sources 84 | 85 | jar-no-fork 86 | 87 | 88 | 89 | 90 | 91 | org.apache.maven.plugins 92 | maven-javadoc-plugin 93 | 94 | 95 | attach-javadocs 96 | 97 | jar 98 | 99 | 100 | 101 | 102 | 103 | org.apache.maven.plugins 104 | maven-gpg-plugin 105 | 1.5 106 | 107 | 108 | sign-artifacts 109 | verify 110 | 111 | sign 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | src/main/java 120 | 121 | **/*.properties 122 | **/*.xml 123 | 124 | false 125 | 126 | 127 | src/main/resources 128 | 129 | **/*.properties 130 | 131 | false 132 | 133 | 134 | 135 | 136 | 137 | release 138 | 139 | 140 | 141 | org.sonatype.plugins 142 | nexus-staging-maven-plugin 143 | 1.6.3 144 | true 145 | 146 | ossrh 147 | https://oss.sonatype.org/ 148 | false 149 | 150 | 151 | 152 | org.apache.maven.plugins 153 | maven-release-plugin 154 | 2.5 155 | 156 | true 157 | false 158 | release 159 | deploy 160 | 161 | 162 | 163 | org.apache.maven.plugins 164 | maven-compiler-plugin 165 | 3.0 166 | 167 | 1.8 168 | 1.8 169 | 170 | 171 | 172 | org.apache.maven.plugins 173 | maven-gpg-plugin 174 | 1.5 175 | 176 | 177 | sign-artifacts 178 | verify 179 | 180 | sign 181 | 182 | 183 | 184 | 185 | 186 | org.apache.maven.plugins 187 | maven-source-plugin 188 | 2.2.1 189 | 190 | 191 | attach-sources 192 | 193 | jar-no-fork 194 | 195 | 196 | 197 | 198 | 199 | org.apache.maven.plugins 200 | maven-javadoc-plugin 201 | 2.9 202 | 203 | 204 | attach-javadocs 205 | 206 | jar 207 | 208 | 209 | 210 | 211 | 212 | 213 | 214 | 215 | 216 | 217 | ossrh 218 | https://oss.sonatype.org/content/repositories/snapshots 219 | 220 | 221 | ossrh 222 | https://oss.sonatype.org/service/local/staging/deploy/maven2/ 223 | 224 | 225 | 226 | -------------------------------------------------------------------------------- /src/test/java/com/github/woostju/test/TestAnsibleClient.java: -------------------------------------------------------------------------------- 1 | package com.github.woostju.test; 2 | 3 | import static org.junit.Assert.assertArrayEquals; 4 | 5 | import java.io.IOException; 6 | import java.util.Map; 7 | 8 | import org.assertj.core.util.Lists; 9 | import org.junit.Before; 10 | import org.junit.Test; 11 | 12 | import com.github.woostju.ansible.AnsibleClient; 13 | import com.github.woostju.ansible.ReturnValue; 14 | import com.github.woostju.ansible.ReturnValue.Result; 15 | import com.github.woostju.ansible.command.CmdCommand; 16 | import com.github.woostju.ansible.command.CopyCommand; 17 | import com.github.woostju.ansible.command.FileCommand; 18 | import com.github.woostju.ansible.command.PingCommand; 19 | import com.github.woostju.ansible.command.PlaybookCommand; 20 | import com.github.woostju.ansible.command.ScriptCommand; 21 | import com.github.woostju.ansible.command.FileCommand.FileCommandState; 22 | import com.github.woostju.ansible.command.GitCommand; 23 | import com.github.woostju.ssh.SshClientConfig; 24 | import com.github.woostju.ssh.pool.SshClientsPool; 25 | 26 | public class TestAnsibleClient { 27 | 28 | static SshClientsPool pool = new SshClientsPool(); 29 | 30 | private SshClientConfig clientConfig; 31 | 32 | private String host = "52.80.146.61"; 33 | 34 | private String host_inner_ip = "172.31.31.82"; 35 | 36 | @Before 37 | public void init() throws IOException { 38 | String path = this.getClass().getClassLoader().getResource("id_rsa").getPath(); 39 | clientConfig = new SshClientConfig(host, 22, "centos", null, path); 40 | } 41 | 42 | private AnsibleClient ansibleClient() { 43 | AnsibleClient client = new AnsibleClient(clientConfig, pool); 44 | client.setInventoryPath("/opt/anchora/cmp/ansible/inventory"); 45 | return client; 46 | } 47 | 48 | private AnsibleClient localAnsibleClient() { 49 | AnsibleClient client = new AnsibleClient(); 50 | client.setAnsibleRootPath("/usr/local/bin/"); 51 | return client; 52 | } 53 | 54 | 55 | @Test 56 | public void testPingSuccess(){ 57 | Map result = ansibleClient().execute(new PingCommand(Lists.newArrayList(host_inner_ip)), 1000); 58 | 59 | assertArrayEquals(new Object[]{ 60 | true,true 61 | }, new Object[]{ 62 | result.get(host_inner_ip).isSuccess(), 63 | result.get(host_inner_ip).getValue("ping").equals("pong") 64 | }); 65 | } 66 | 67 | @Test 68 | public void testPingdLocalSuccess() { 69 | Map result = localAnsibleClient().execute(new PingCommand(Lists.newArrayList("127.0.0.1")), 100); 70 | assertArrayEquals(new Object[]{ 71 | true, true 72 | }, new Object[]{ 73 | result.get("127.0.0.1").isSuccess(), 74 | result.get("127.0.0.1").getValue("ping").equals("pong") 75 | }); 76 | } 77 | 78 | @Test 79 | public void testUnmanagedNode(){ 80 | Map result = ansibleClient().execute(new PingCommand(Lists.newArrayList(host_inner_ip+1)), 1000); 81 | 82 | assertArrayEquals(new Object[]{ 83 | ReturnValue.Result.unmanaged 84 | }, new Object[]{ 85 | result.get(host_inner_ip+1).getResult() 86 | }); 87 | } 88 | 89 | @Test 90 | public void testCommandSuccess() { 91 | Map result = ansibleClient().execute(new CmdCommand(Lists.newArrayList(host_inner_ip), "echo '123'"), 100); 92 | assertArrayEquals(new Object[]{ 93 | true, 0, 1l 94 | }, new Object[]{ 95 | result.get(host_inner_ip).isSuccess(), 96 | result.get(host_inner_ip).getRc(), 97 | result.get(host_inner_ip).getStdout().stream().filter(item->item.equals("123")).count() 98 | }); 99 | } 100 | 101 | @Test 102 | public void testCommandLocalSuccess() { 103 | Map result = localAnsibleClient().execute(new CmdCommand(Lists.newArrayList("127.0.0.1"), "echo '123'"), 100); 104 | assertArrayEquals(new Object[]{ 105 | true, 0, 1l 106 | }, new Object[]{ 107 | result.get("127.0.0.1").isSuccess(), 108 | result.get("127.0.0.1").getRc(), 109 | result.get("127.0.0.1").getStdout().stream().filter(item->item.equals("123")).count() 110 | }); 111 | } 112 | 113 | @Test 114 | public void testCommandFailed() { 115 | Map result = ansibleClient().execute(new CmdCommand(Lists.newArrayList(host_inner_ip), "echo1 '123'"), 100); 116 | assertArrayEquals(new Object[]{ 117 | false, 2, 0l 118 | }, new Object[]{ 119 | result.get(host_inner_ip).isSuccess(), 120 | result.get(host_inner_ip).getRc(), 121 | result.get(host_inner_ip).getStdout().stream().filter(item->item.equals("123")).count() 122 | }); 123 | } 124 | 125 | @Test 126 | public void testFileAndCopySuccess() { 127 | Map result = ansibleClient().execute(new FileCommand(Lists.newArrayList(host_inner_ip), "/tmp/a", FileCommandState.touch), 100); 128 | 129 | result = ansibleClient().execute(new CopyCommand(Lists.newArrayList(host_inner_ip), "/tmp/a", "/tmp/b", true, null, null), 100); 130 | assertArrayEquals(new Object[]{ 131 | true, 132 | }, new Object[]{ 133 | result.get(host_inner_ip).isSuccess(), 134 | }); 135 | 136 | result = ansibleClient().execute(new FileCommand(Lists.newArrayList(host_inner_ip), "/tmp/a", FileCommandState.absent), 100); 137 | result = ansibleClient().execute(new FileCommand(Lists.newArrayList(host_inner_ip), "/tmp/b", FileCommandState.absent), 100); 138 | } 139 | 140 | // 141 | @Test 142 | public void testGitSuccess() { 143 | Map result = ansibleClient().execute(new GitCommand(Lists.newArrayList(host_inner_ip), "https://github.com/woostju/ssh-client-pool.git", "/tmp/ssh-client-pool", null), 1000); 144 | assertArrayEquals(new Object[]{ 145 | true, 146 | }, new Object[]{ 147 | result.get(host_inner_ip).isSuccess(), 148 | }); 149 | 150 | result = ansibleClient().execute(new FileCommand(Lists.newArrayList(host_inner_ip), "/tmp/ssh-client-pool/LICENSE", FileCommandState.file), 100); 151 | assertArrayEquals(new Object[]{ 152 | true, 153 | }, new Object[]{ 154 | result.get(host_inner_ip).isSuccess(), 155 | }); 156 | } 157 | 158 | @Test 159 | public void testGitFailed() { 160 | Map result = ansibleClient().execute(new GitCommand(Lists.newArrayList(host_inner_ip), "git@github.com:woostju/ssh-client-pool.git", "/tmp/ssh-client-pool", null), 1000); 161 | assertArrayEquals(new Object[]{ 162 | false, 163 | }, new Object[]{ 164 | result.get(host_inner_ip).isSuccess(), 165 | }); 166 | } 167 | 168 | @Test 169 | public void testScriptSuccess() { 170 | String path = this.getClass().getClassLoader().getResource("script.sh").getPath(); 171 | localAnsibleClient().execute(new CopyCommand(Lists.newArrayList(clientConfig.getHost()), path, "/tmp/script.sh", true, null, null), 100); 172 | 173 | Map result = ansibleClient().execute(new ScriptCommand(Lists.newArrayList(host_inner_ip), "/tmp/script.sh", "/bin/sh"), 100); 174 | assertArrayEquals(new Object[]{ 175 | true, 176 | }, new Object[]{ 177 | result.get(host_inner_ip).isSuccess(), 178 | }); 179 | result = ansibleClient().execute(new FileCommand(Lists.newArrayList(host_inner_ip), "/tmp/script.sh", FileCommandState.absent), 100); 180 | } 181 | 182 | @Test 183 | public void testScriptFailed() { 184 | Map result = ansibleClient().execute(new ScriptCommand(Lists.newArrayList(host_inner_ip), "/tmp/script2.sh", "/bin/sh"), 100); 185 | assertArrayEquals(new Object[]{ 186 | false, 187 | }, new Object[]{ 188 | result.get(host_inner_ip).isSuccess(), 189 | }); 190 | } 191 | 192 | @Test 193 | public void testPlaybookSuccess() { 194 | String path = this.getClass().getClassLoader().getResource("playbook-unittest-success.yaml").getPath(); 195 | localAnsibleClient().execute(new CopyCommand(Lists.newArrayList(clientConfig.getHost()), path, "/tmp/playbook-unittest-success.yaml", true, null, null), 100); 196 | 197 | Map result = ansibleClient().execute(new PlaybookCommand(Lists.newArrayList(host_inner_ip,"172.31.31.81"), "/tmp/playbook-unittest-success.yaml", null), 100); 198 | assertArrayEquals(new Object[]{ 199 | true, Result.unmanaged 200 | }, new Object[]{ 201 | result.get(host_inner_ip).isSuccess(), 202 | result.get("172.31.31.81").getResult() 203 | }); 204 | } 205 | 206 | } 207 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------