appium_instrumenter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2675a0f42db37813b11315828f9ac55e5641561f
+  data.tar.gz: a9485751504d8e77772ca20740acd782321ae493
+SHA512:
+  metadata.gz: 3a24910468decc5b8610033a69f817dae143c868533489e0a1171239bf1a245f7157db9d90067cd5e2f7edc5f5fb3e76cabcbdc9198117c84cf94e76c5532647
+  data.tar.gz: 8d474d8ea9d9d59b331353b758c919c817dd4317eebdfab89958b9b17818311b521fcd45584c5be833a6677b5cd9a24734579a7de9fddcee6572e4f8fcc229a9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+appium_instrumenter

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mail.rajvarma@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in appium_instrumenter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    appium_instrumenter (0.1.0)
+      escape (~> 0.0.4)
+      luffa
+      rubyzip (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    escape (0.0.4)
+    json (1.8.6)
+    luffa (2.0.0)
+      awesome_print (~> 1.2)
+      json (~> 1.8)
+      retriable (>= 1.3.3.1, < 2.1)
+      thor (~> 0.19)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    retriable (2.0.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubyzip (1.2.1)
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appium_instrumenter!
+  bundler (~> 1.16)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Rajdeep Varma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# AppiumInstrumenter
+Part of calabash-android ruby gem to instrument and resign apk.
+This will modify appium uiautomator2 server apk so that it instruments app under test.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'appium_instrumenter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install appium_instrumenter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/appium_instrumenter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AppiumInstrumenter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/appium_instrumenter/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/appium_instrumenter.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "appium_instrumenter/version"
+
+
+Gem::Specification.new do |spec|
+  spec.name          = "appium_instrumenter"
+  spec.version       = AppiumInstrumenter::VERSION
+  spec.authors       = ["Rajdeep Varma"]
+  spec.email         = ["mail.rajvarma@gmail.com"]
+
+  spec.summary       = %q{Part of calabash-android ruby gem to instrument and resign apk}
+  spec.description   = %q{Part of calabash-android ruby gem to instrument and resign apk.
+This will modify appium uiautomator2 server apk so that it instruments app under test.}
+  spec.homepage      = "https://github.com/rajdeepv/appium_instrumenter"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_dependency( 'luffa' )
+  spec.add_dependency( "rubyzip", "~> 1.1" )
+  spec.add_dependency( 'escape', '~> 0.0.4')
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "appium_instrumenter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/appium_instrumenter

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+require "appium_instrumenter"
+
+
+def print_usage
+  puts "appium_instrumenter instrument <appium-server-apk-path> <app_under_test_path>"
+  puts "OR"
+  puts "appium_instrumenter resign <apk-path>"
+end
+
+def is_apk_file?(file_path)
+  file_path.end_with? ".apk" and File.exist? file_path
+end
+
+def relative_to_full_path(file_path)
+  File.expand_path(file_path)
+end
+
+if ARGV.length == 0
+  print_usage
+else
+  cmd = ARGV.shift
+  case cmd
+    when 'instrument'
+      app_to_instrument = ARGV[0]
+      app_under_test = ARGV[1]
+      if ARGV.size < 2
+        puts "Please see usage below. Specify two arguments"
+        print_usage
+      elsif !File.exist?(app_to_instrument)
+        puts "Could not find file '#{app_to_instrument}'"
+        exit 1
+      elsif !is_apk_file?(app_to_instrument)
+        puts "'#{app_to_instrument}' is not a valid android application"
+        exit 1
+      elsif !File.exist?(app_under_test)
+        puts "Could not find file '#{app_under_test}'"
+        exit 1
+      elsif !is_apk_file?(app_under_test)
+        puts "'#{app_under_test}' is not a valid android application"
+        exit 1
+      else
+        app_to_instrument_path = relative_to_full_path(app_to_instrument)
+        app_under_test_path = relative_to_full_path(app_under_test)
+        AppiumInstrumenter.instrument(app_to_instrument_path, app_under_test_path)
+      end
+
+    when 'resign'
+      app_to_resign = ARGV[0]
+      fail("Please specify app to sign") unless ARGV[0]
+      AppiumInstrumenter.unsign_and_resign_apk(relative_to_full_path(app_to_resign))
+    else
+      puts "Invalid command '#{cmd}'"
+      print_usage
+  end
+end

data/lib/appium_instrumenter.rb

@@ -0,0 +1,76 @@
+require "appium_instrumenter/version"
+require "appium_instrumenter/helpers"
+require "appium_instrumenter/java_keystore"
+
+module AppiumInstrumenter
+  def self.instrument(test_server_apk, app_under_test)
+    apk_fingerprint = fingerprint_from_apk(app_under_test)
+    log "#{app_under_test} was signed with a certificate with fingerprint #{apk_fingerprint}"
+
+    keystores = JavaKeystore.get_keystores
+    if keystores.empty?
+      puts "No keystores found."
+      exit 1
+    end
+    keystore = keystores.find { |k| k.fingerprint == apk_fingerprint}
+
+    unless keystore
+      puts "#{app_under_test} is not signed with any of the available keystores."
+      puts "Tried the following keystores:"
+      keystores.each do |k|
+        puts k.location
+      end
+      puts ""
+      puts "You can resign the app_under_test with #{keystores.first.location} by running:
+    appium_instrumenter resign #{app_under_test}"
+
+      puts ""
+      puts "Notice that resigning an app_under_test might break some functionality."
+      puts "Getting a copy of the certificate used when the app_under_test was built will in general be more reliable."
+
+      exit 1
+    end
+
+    test_server_file_name = 'test_servers/appium-uiautomator2-server-debug-androidTest.apk'
+    FileUtils.mkdir_p File.dirname(test_server_file_name) unless File.exist? File.dirname(test_server_file_name)
+
+    unsign_apk(test_server_apk)
+    test_server_manifest = File.join(File.dirname(__FILE__), 'appium_instrumenter/resources/AndroidManifest.xml')
+
+    Dir.mktmpdir do |workspace_dir|
+      Dir.chdir(workspace_dir) do
+        FileUtils.cp(test_server_apk, "TestServer.apk")
+        FileUtils.cp(test_server_manifest, "AndroidManifest.xml")
+
+        unless system %Q{"#{RbConfig.ruby}" -pi.bak -e "gsub(/#targetPackage#/, '#{package_name(app_under_test)}')" AndroidManifest.xml}
+          raise "Could not replace package name in manifest"
+        end
+
+        unless system %Q{"#{Calabash::Android::Dependencies.aapt_path}" package -M AndroidManifest.xml  -I "#{Calabash::Android::Dependencies.android_jar_path}" -F dummy.apk}
+          raise "Could not create dummy.apk"
+        end
+
+        Calabash::Utils.with_silent_zip do
+          Zip::File.new("dummy.apk").extract("AndroidManifest.xml","customAndroidManifest.xml")
+          Zip::File.open("TestServer.apk") do |zip_file|
+
+            zip_file.remove("AndroidManifest.xml")
+            zip_file.add("AndroidManifest.xml", "customAndroidManifest.xml")
+          end
+        end
+      end
+      keystore.sign_apk("#{workspace_dir}/TestServer.apk", test_server_file_name)
+      begin
+
+      rescue => e
+        log e
+        raise "Could not sign test server"
+      end
+    end
+    puts "Done signing the test server. Moved it to #{test_server_file_name}"
+  end
+
+  def self.unsign_and_resign_apk(apk_path)
+    resign_apk(apk_path)
+  end
+end