appmap 0.31.0

data/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "appmap-ruby-lore",
+  "version": "1.0.0",
+  "description": "Lore for the AppMap Rubygem",
+  "scripts": {
+    "start": "./node_modules/applore/bin/lore serve"
+  },
+  "directories": {
+    "example": "examples",
+    "lib": "lib",
+    "test": "test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/applandinc/appmap-ruby.git"
+  },
+  "bugs": {
+    "url": "https://github.com/applandinc/appmap-ruby/issues"
+  },
+  "homepage": "https://github.com/applandinc/appmap-ruby#readme",
+  "dependencies": {
+    "applore": "^0.3.0"
+  }
+}

data/spec/abstract_controller4_base_spec.rb

@@ -0,0 +1,67 @@
+require 'rails_spec_helper'
+
+describe 'AbstractControllerBase' do
+  before(:all) { @fixture_dir = 'spec/fixtures/rails4_users_app' }
+  include_examples 'Rails app pg database'
+  
+  around(:each) do |example|
+    FileUtils.rm_rf tmpdir
+    FileUtils.mkdir_p tmpdir
+    cmd = "docker-compose run --rm -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:8"
+    run_cmd cmd, chdir: @fixture_dir
+
+    example.run
+  end
+
+  let(:tmpdir) { 'tmp/spec/AbstractControllerBase' }
+  let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
+
+  describe 'testing with rspec' do
+    it 'Message fields are recorded in the appmap' do
+      expect(File).to exist(appmap_json)
+      appmap = JSON.parse(File.read(appmap_json)).to_yaml
+
+      expect(appmap).to include(<<-MESSAGE.strip)
+  message:
+  - name: login
+    class: String
+    value: alice
+    object_id:
+      MESSAGE
+
+      expect(appmap).to include(<<-MESSAGE.strip)
+  - name: password
+    class: String
+    value: "[FILTERED]"
+    object_id:
+      MESSAGE
+
+      expect(appmap).to include(<<-SERVER_REQUEST.strip)
+  http_server_request:
+    request_method: POST
+    path_info: "/api/users?login=alice&password=foobar
+      SERVER_REQUEST
+    end
+    it 'Properly captures method parameters in the appmap' do
+      expect(File).to exist(appmap_json)
+      appmap = JSON.parse(File.read(appmap_json)).to_yaml
+
+      expect(appmap).to match(<<-CREATE_CALL.strip)
+  event: call
+  defined_class: Api::UsersController
+  method_id: build_user
+  path: app/controllers/api/users_controller.rb
+  lineno: 23
+  thread_id: .*
+  static: false
+  parameters:
+  - name: params
+    class: Hash
+    object_id: .*
+    value: '{"login"=>"alice"}'
+    kind: req
+  receiver:
+      CREATE_CALL
+    end
+  end
+end

data/spec/abstract_controller_base_spec.rb

@@ -0,0 +1,72 @@
+require 'rails_spec_helper'
+
+describe 'AbstractControllerBase' do
+  before(:all) { @fixture_dir = 'spec/fixtures/rails_users_app' }
+  include_context 'Rails app pg database'
+
+  around(:each) do |example|
+    FileUtils.rm_rf tmpdir
+    FileUtils.mkdir_p tmpdir
+    cmd = "docker-compose run --rm -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:8"
+    run_cmd cmd, chdir: @fixture_dir
+
+    example.run
+  end
+
+  let(:tmpdir) { 'tmp/spec/AbstractControllerBase' }
+  let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
+
+  describe 'testing with rspec' do
+    it 'inventory file is printed' do
+      expect(File).to exist(File.join(tmpdir, 'appmap/rspec/Inventory.appmap.json'))
+    end
+
+    it 'message fields are recorded in the appmap' do
+      expect(File).to exist(appmap_json)
+      appmap = JSON.parse(File.read(appmap_json)).to_yaml
+
+      expect(appmap).to include(<<-MESSAGE.strip)
+  message:
+  - name: login
+    class: String
+    value: alice
+    object_id:
+      MESSAGE
+
+      expect(appmap).to include(<<-MESSAGE.strip)
+  - name: password
+    class: String
+    value: "[FILTERED]"
+    object_id:
+      MESSAGE
+
+      expect(appmap).to include(<<-SERVER_REQUEST.strip)
+  http_server_request:
+    request_method: POST
+    path_info: "/api/users"
+      SERVER_REQUEST
+    end
+
+    it 'Properly captures method parameters in the appmap' do
+      expect(File).to exist(appmap_json)
+      appmap = JSON.parse(File.read(appmap_json)).to_yaml
+
+      expect(appmap).to match(<<-CREATE_CALL.strip)
+  event: call
+  defined_class: Api::UsersController
+  method_id: build_user
+  path: app/controllers/api/users_controller.rb
+  lineno: 23
+  thread_id: .*
+  static: false
+  parameters:
+  - name: params
+    class: ActiveSupport::HashWithIndifferentAccess
+    object_id: .*
+    value: '{"login"=>"alice"}'
+    kind: req
+  receiver:
+      CREATE_CALL
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails_spec_helper'
+require 'active_support/core_ext'
+require 'appmap/config'
+
+describe AppMap::Config, docker: false do
+  it 'loads from a Hash' do
+    config_data = {
+      name: 'test',
+      packages: [
+        {
+          path: 'path-1'
+        },
+        {
+          path: 'path-2',
+          exclude: [ 'exclude-1' ]
+        }
+      ]
+    }.deep_stringify_keys!
+    config = AppMap::Config.load(config_data)
+
+    expect(config.to_h.deep_stringify_keys!).to eq(config_data)
+  end
+end

data/spec/fixtures/hook/attr_accessor.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class AttrAccessor
+  attr_accessor :value
+end

data/spec/fixtures/hook/compare.rb

@@ -0,0 +1,7 @@
+require 'active_support/security_utils'
+
+class Compare
+  def self.compare(s1, s2)
+    ActiveSupport::SecurityUtils.secure_compare(s1, s2)
+  end
+end

data/spec/fixtures/hook/constructor.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Constructor
+  def initialize(value)
+    @value = value
+  end
+end

data/spec/fixtures/hook/exception_method.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ExceptionMethod
+  def to_s
+    'Exception Method fixture'
+  end
+
+  def raise_exception
+    raise 'Exception occurred in raise_exception'
+  end
+end

data/spec/fixtures/hook/instance_method.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class InstanceMethod
+  def to_s
+    'Instance Method fixture'
+  end
+
+  def say_default
+    'default'
+  end
+
+  def say_echo(arg)
+    arg.to_s
+  end
+
+  def say_kw(kw: 'kw')
+    kw.to_s
+  end
+
+  def say_block(&block)
+    yield
+  end
+end

data/spec/fixtures/hook/openssl_sign.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# From the manual page https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL.html
+
+require 'openssl'
+
+module OpenSSLExample
+  def OpenSSLExample.example
+    ca_key = OpenSSL::PKey::RSA.new 2048
+    pass_phrase = 'my secure pass phrase goes here'
+
+    cipher = OpenSSL::Cipher.new 'AES-256-CBC'
+
+    open 'tmp/ca_key.pem', 'w', 0644 do |io|
+      io.write ca_key.export(cipher, pass_phrase)
+    end
+
+    ca_name = OpenSSL::X509::Name.parse '/CN=ca/DC=example'
+
+    ca_cert = OpenSSL::X509::Certificate.new
+    ca_cert.serial = 0
+    ca_cert.version = 2
+    ca_cert.not_before = Time.now
+    ca_cert.not_after = Time.now + 86400
+
+    ca_cert.public_key = ca_key.public_key
+    ca_cert.subject = ca_name
+    ca_cert.issuer = ca_name
+
+    extension_factory = OpenSSL::X509::ExtensionFactory.new
+    extension_factory.subject_certificate = ca_cert
+    extension_factory.issuer_certificate = ca_cert
+
+    ca_cert.add_extension    extension_factory.create_extension('subjectKeyIdentifier', 'hash')
+    ca_cert.add_extension    extension_factory.create_extension('basicConstraints', 'CA:TRUE', true)
+
+    ca_cert.add_extension    extension_factory.create_extension(
+      'keyUsage', 'cRLSign,keyCertSign', true)
+
+    ca_cert.sign ca_key, OpenSSL::Digest::SHA1.new
+
+    open 'tmp/ca_cert.pem', 'w' do |io|
+      io.write ca_cert.to_pem
+    end
+
+    csr = OpenSSL::X509::Request.new
+    csr.version = 0
+    csr.subject = OpenSSL::X509::Name.new([ ['CN', 'the name to sign', OpenSSL::ASN1::UTF8STRING] ])
+    csr.public_key = ca_key.public_key
+    csr.sign ca_key, OpenSSL::Digest::SHA1.new
+
+    open 'tmp/csr.pem', 'w' do |io|
+      io.write csr.to_pem
+    end
+
+    csr = OpenSSL::X509::Request.new File.read 'tmp/csr.pem'
+
+    raise 'CSR can not be verified' unless csr.verify csr.public_key
+
+    csr_cert = OpenSSL::X509::Certificate.new
+    csr_cert.serial = 0
+    csr_cert.version = 2
+    csr_cert.not_before = Time.now
+    csr_cert.not_after = Time.now + 600
+
+    csr_cert.subject = csr.subject
+    csr_cert.public_key = csr.public_key
+    csr_cert.issuer = ca_cert.subject
+
+    extension_factory = OpenSSL::X509::ExtensionFactory.new
+    extension_factory.subject_certificate = csr_cert
+    extension_factory.issuer_certificate = ca_cert
+
+    csr_cert.add_extension    extension_factory.create_extension('basicConstraints', 'CA:FALSE')
+
+    csr_cert.add_extension    extension_factory.create_extension(
+        'keyUsage', 'keyEncipherment,dataEncipherment,digitalSignature')
+
+    csr_cert.add_extension    extension_factory.create_extension('subjectKeyIdentifier', 'hash')
+
+    csr_cert.sign ca_key, OpenSSL::Digest::SHA1.new
+
+    open 'tmp/csr_cert.pem', 'w' do |io|
+      io.write csr_cert.to_pem
+    end
+  end
+end

data/spec/fixtures/hook/singleton_method.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+class SingletonMethod
+  class << self
+    def say_default
+      'default'
+    end
+  end
+
+  def SingletonMethod.say_class_defined
+    'defined with explicit class scope'
+  end
+
+  def self.say_self_defined
+    'defined with self class scope'
+  end
+
+  # When called, do_include calls +include+ to bring in the module
+  # AddMethod. AddMethod defines a new instance method, which gets
+  # added to the singleton class of SingletonMethod.
+  def do_include
+    class << self
+      SingletonMethod.include(AddMethod)
+    end
+    self
+  end
+  
+  def self.new_with_instance_method
+    SingletonMethod.new.tap do |m|
+      def m.say_instance_defined
+        'defined for an instance'
+      end
+    end
+  end
+  
+  def to_s
+    'Singleton Method fixture'
+  end
+end
+
+module AddMethod
+  def self.included(base)
+    base.module_eval do
+      define_method "added_method" do
+        _added_method
+      end
+    end
+  end
+  
+  def _added_method
+    'defined by including a module'
+  end
+end
+

data/spec/fixtures/rack_users_app/.dockerignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+

data/spec/fixtures/rack_users_app/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+

data/spec/fixtures/rack_users_app/Dockerfile

@@ -0,0 +1,32 @@
+ARG GEM_VERSION
+ARG RUBY_VERSION
+
+FROM appmap:${GEM_VERSION} as appmap
+
+FROM ruby:${RUBY_VERSION}
+RUN apt-get update && apt-get install -y vim less
+
+RUN mkdir /app
+WORKDIR /app
+
+RUN gem install -N bundler
+
+COPY Gemfile .
+
+RUN bundle
+RUN bundle binstubs rack
+
+COPY . .
+
+COPY --from=appmap /pkg/appmap.gem /tmp/
+RUN gem install /tmp/appmap.gem && \
+    bundle update --local appmap && \
+    bundle binstubs appmap --force
+
+EXPOSE 9292
+
+ENV GLI_DEBUG=true
+
+ENTRYPOINT [ "./bin/appmap", "record", "-o", "tmp/appmap.json" ]
+
+HEALTHCHECK --interval=1s --retries=10 CMD curl --fail http://localhost:9292/health || exit 1

data/spec/fixtures/rack_users_app/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'rack'
+gem 'rack-app'
+gem 'rspec'
+gem 'pry-byebug'
+
+appmap_gem_opts = {}
+appmap_gem_opts[:path] = '../../..' if File.exist?('../../../appmap.gemspec')
+gem 'appmap', appmap_gem_opts