jenkins_shell 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b75e3e5e33e080ce9171c0b0ee8db6516c0ac65caf40f6439f2ab29d46a8f48
-  data.tar.gz: 8d6e7aa40827b25a6c0ae21be8189aa91e2117100578a033dadfbb8d9adab657
+  metadata.gz: 2a3c4e6f5e959d87ca2844c64a33796acd3f451ab3a539f9753ddcc3c513d79f
+  data.tar.gz: 18488798eeaf5089518edfd2d99318a388b28d7e1a555769fa140682e4f5fb91
 SHA512:
-  metadata.gz: ac037325b5a840fb70578e5dc11705b22d21653d0f26e8d8cae5afb550220d483076d4e992c137cbc7260fe5626a3a3d6eb0443fc8acf79caeae6bce598aa6fa
-  data.tar.gz: 317538957c5d1f4d0d4e16f170926d0e67cca4612652cf1acaeba0406030fac8cd3096e006274f72e359d16d4fc8ad08c8e5224ba2c919e0c85394ae81c9b4e6
+  metadata.gz: bb5d6ca84706904c59e0626eaa60e91e3e536558dc3fa37103b301a65fe608af89f7fa5972a6e5c74bf0f548dabe3cf7e3e08cc80ca631de71629d017396a6f4
+  data.tar.gz: 447d92effb45eb20436baa27f5da20811aa23a8d7ac18dbdb81c853a6fb73588385857043747c8fe9e5d09aee823cca9f37f409f87dd89ec7162724a4ed56ee5

data/bin/jsh

@@ -16,9 +16,18 @@ class JShExit
     AMBIGUOUS_ARGUMENT = 6
 end
 
+def get_password
+    print "Enter password: "
+    passwd = STDIN.noecho(&:gets)
+    puts
+    return passwd.chomp
+end
+
 def parse(args)
     options = Hash.new
+    options["password"] = nil
     options["port"] = "8080"
+    options["username"] = nil
     options["verbose"] = false
 
     info = "Simulate a cmd prompt using Jenkins script functionality"
@@ -45,6 +54,13 @@ def parse(args)
             Hilighter.disable
         end
 
+        opts.on(
+            "--password=PASSWORD",
+            "Use specified password (will prompt if not provided)"
+        ) do |password|
+            options["password"] = password
+        end
+
         opts.on(
             "-p",
             "--port=PORT",
@@ -53,6 +69,10 @@ def parse(args)
             options["port"] = port
         end
 
+        opts.on("-u", "--user=USER", "Use specified username") do |u|
+            options["username"] = u
+        end
+
         opts.on(
             "-v",
             "--verbose",
@@ -98,7 +118,14 @@ end
 options = parse(ARGV)
 
 begin
-    jsh = JenkinsShell.new(options["host"], options["port"])
+    passwd = options["password"]
+    passwd = get_password if (options["username"] && passwd.nil?)
+    jsh = JenkinsShell.new(
+        options["host"],
+        options["port"],
+        options["username"],
+        passwd
+    )
 
     djinni = Djinni.new
     djinni.fallback = "cmd"

data/lib/jenkins_shell.rb

@@ -3,9 +3,13 @@ require "rexml/document"
 require "uri"
 
 class JenkinsShell
+    attr_reader :cookie
+    attr_reader :crumb
     attr_reader :cwd
     attr_reader :host
+    attr_reader :password
     attr_reader :port
+    attr_reader :username
 
     def cd(dir = nil)
         return true if (dir.nil? || dir.empty?)
@@ -21,20 +25,48 @@ class JenkinsShell
     end
 
     def command(cmd, dir = @int_cwd)
-        # Create and encode Groovy script
+        login if (@username && (@cookie.nil? || @crumb.nil?))
+        if (@username && (@cookie.nil? || @crumb.nil?))
+            raise JenkinsShell::Error::LoginFailure.new
+        end
+
+        # Create Groovy script
         fix = dir.gsub(/\\/, "\\\\\\")
         gs = "println(\"cmd /c cd #{fix} && #{cmd}\".execute().text)"
-        enc = URI::encode(URI::encode(gs), "&()/").gsub("%20", "+")
 
+        # Make POST request and return command output
+        xml = post("/script", "script=#{encode(gs)}")[1]
+        output = xml.get_elements("html/body/div/div/pre")[1]
+        return "" if (output.nil?)
+        return output.text.strip
+    end
+
+    def encode(str)
+        # TODO what other chars need encoded?
+        return URI::encode(URI::encode(str), "@&()/").gsub("%20", "+")
+    end
+    private :encode
+
+    def get(path)
         begin
-            # Establish connection and send script
+            # Establish connection
             http = Net::HTTP.new(@host, @port)
-            xml = REXML::Document.new(
-                http.post("/script", "script=#{enc}").body
-            )
 
-            # Parse response and return script output
-            return xml.get_elements("html/body/div/div/pre")[1].text
+            # Create request
+            req = Net::HTTP::Get.new(path)
+            req["Cookie"] = @cookie if (@cookie)
+
+            # Send request and get response
+            res = http.request(req)
+
+            # Parse HTML body
+            xml = REXML::Document.new(res.body)
+
+            # Store needed values
+            store_state(res, xml)
+
+            # Return headers and xml body
+            return res, xml
         rescue Errno::ECONNREFUSED
             raise JenkinsShell::Error::ConnectionRefused.new(
                 @host,
@@ -43,22 +75,88 @@ class JenkinsShell
         rescue REXML::ParseException
             raise JenkinsShell::Error::InvalidHTMLReceived.new
         end
-        return ""
     end
+    private :get
 
-    def initialize(host, port = 8080)
+    def initialize(host, port = 8080, username = nil, password = nil)
+        @cookie = nil
+        @crumb = nil
         @int_cwd = "."
         @host = host.gsub(/^https?:\/\/|(:[0-9]+)?\/.+/, "")
+        @password = password
         @port = port
+        @username = username
         @cwd = pwd
     end
 
+    def login
+        get("/login")
+        post(
+            "/j_acegi_security_check",
+            [
+                "j_username=#{encode(@username)}",
+                "j_password=#{encode(@password)}",
+                "Submit=log+in"
+            ].join("&")
+        )
+        get("/")
+    end
+
+    def post(path, data)
+        body = Array.new
+        body.push("Jenkins-Crumb=#{@crumb}") if (@crumb)
+        body.push(data)
+
+        begin
+            # Establish connection
+            http = Net::HTTP.new(@host, @port)
+
+            # Create request
+            req = Net::HTTP::Post.new(path)
+            req.body = body.join("&")
+            req["Cookie"] = @cookie if (@cookie)
+
+            # Send request and get response
+            res = http.request(req)
+
+            # Parse HTML response
+            xml = REXML::Document.new(res.body)
+
+            # Store needed values
+            store_state(res, xml)
+
+            # Return headers and xml body
+            return res, xml
+        rescue Errno::ECONNREFUSED
+            raise JenkinsShell::Error::ConnectionRefused.new(
+                @host,
+                @port
+            )
+        rescue REXML::ParseException
+            raise JenkinsShell::Error::InvalidHTMLReceived.new
+        end
+    end
+    private :post
+
     def pwd(dir = @int_cwd)
         command("dir", dir).match(/^\s+Directory of (.+)/) do |m|
             return m[1]
         end
         return ""
     end
+
+    def store_state(headers, xml)
+        # Store crumb if it exists
+        crumb = xml.get_elements("html/head/script").join
+        crumb.match(/"Jenkins-Crumb", "([A-Fa-f0-9]+)"/) do |m|
+            @crumb = m[1]
+        end
+
+        # Store cookie if there is one
+        new_cookie = headers["Set-Cookie"]
+        @cookie = new_cookie if (new_cookie)
+    end
+    private :store_state
 end
 
 require "jenkins_shell/error"

data/lib/jenkins_shell/error.rb

@@ -3,3 +3,4 @@ end
 
 require "jenkins_shell/error/connection_refused"
 require "jenkins_shell/error/invalid_html_received"
+require "jenkins_shell/error/login_failure"

data/lib/jenkins_shell/error/login_failure.rb

@@ -0,0 +1,5 @@
+class JenkinsShell::Error::LoginFailure < JenkinsShell::Error
+    def initialize
+        super("Failure to login")
+    end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_shell
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Miles Whittaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-15 00:00:00.000000000 Z
+date: 2018-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -83,6 +83,7 @@ files:
 - lib/jenkins_shell/error.rb
 - lib/jenkins_shell/error/connection_refused.rb
 - lib/jenkins_shell/error/invalid_html_received.rb
+- lib/jenkins_shell/error/login_failure.rb
 - lib/jenkins_shell/wish/cd_wish.rb
 - lib/jenkins_shell/wish/cmd_wish.rb
 - lib/jenkins_shell/wish/ls_wish.rb