appmap 0.28.0 → 0.34.0

data/spec/record_sql_rails_pg_spec.rb

@@ -1,6 +1,6 @@
 require 'rails_spec_helper'
 
-describe 'Record SQL queries in a Rails app' do
+describe 'SQL events' do
   before(:all) { @fixture_dir = 'spec/fixtures/rails_users_app' }
   include_context 'Rails app pg database'
 
@@ -14,54 +14,77 @@ describe 'Record SQL queries in a Rails app' do
   end
 
   let(:tmpdir) { "tmp/spec/record_sql_rails_pg_spec" }
-  let(:appmap) { JSON.parse(File.read(appmap_json)).to_yaml }
 
-  context 'while creating a new record' do
+  describe 'fields' do
     let(:test_line_number) { 8 }
     let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
+    let(:orm_module) { 'sequel' }
+    let(:appmap) { JSON.parse(File.read(appmap_json)) }
+    describe 'on a call event' do
+      let(:event) do
+        appmap['events'].find do |event|
+          event['event'] == 'call' &&
+            event.keys.include?('sql_query')
+        end
+      end
+      it 'do not include function-only fields' do
+        expect(event.keys).to_not include('defined_class')
+        expect(event.keys).to_not include('method_id')
+        expect(event.keys).to_not include('path')
+        expect(event.keys).to_not include('lineno')
+      end
+    end
+  end
+
+  describe 'in a Rails app' do
+    let(:appmap) { JSON.parse(File.read(appmap_json)).to_yaml }
+    context 'while creating a new record' do
+      let(:test_line_number) { 8 }
+      let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
 
-    context 'using Sequel ORM' do
-      let(:orm_module) { 'sequel' }
-      it 'detects the sql INSERT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+      context 'using Sequel ORM' do
+        let(:orm_module) { 'sequel' }
+        it 'detects the sql INSERT' do
+          expect(appmap).to include(<<-SQL_QUERY.strip)
   sql_query:
     sql: INSERT INTO "users" ("login") VALUES ('alice') RETURNING *
-        SQL_QUERY
+          SQL_QUERY
+        end
       end
-    end
-    context 'using ActiveRecord ORM' do
-      let(:orm_module) { 'activerecord' }
-      it 'detects the sql INSERT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+      context 'using ActiveRecord ORM' do
+        let(:orm_module) { 'activerecord' }
+        it 'detects the sql INSERT' do
+          expect(appmap).to include(<<-SQL_QUERY.strip)
   sql_query:
     sql: INSERT INTO "users" ("login") VALUES ($1) RETURNING "id"
-        SQL_QUERY
+          SQL_QUERY
+        end
       end
     end
-  end
-
-  context 'while listing records' do
-    let(:test_line_number) { 23 }
-    let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_GET_api_users_lists_the_users.appmap.json') }
-
-    context 'using Sequel ORM' do
-      let(:orm_module) { 'sequel' }
-      it 'detects the sql SELECT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+  
+    context 'while listing records' do
+      let(:test_line_number) { 23 }
+      let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_GET_api_users_lists_the_users.appmap.json') }
+  
+      context 'using Sequel ORM' do
+        let(:orm_module) { 'sequel' }
+        it 'detects the sql SELECT' do
+          expect(appmap).to include(<<-SQL_QUERY.strip)
   sql_query:
     sql: SELECT * FROM "users"
-        SQL_QUERY
-
-        expect(appmap).to include('sql:')
+          SQL_QUERY
+  
+          expect(appmap).to include('sql:')
+        end
       end
-    end
-    context 'using ActiveRecord ORM' do
-      let(:orm_module) { 'activerecord' }
-      it 'detects the sql SELECT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+      context 'using ActiveRecord ORM' do
+        let(:orm_module) { 'activerecord' }
+        it 'detects the sql SELECT' do
+          expect(appmap).to include(<<-SQL_QUERY.strip)
   sql_query:
     sql: SELECT "users".* FROM "users"
-        SQL_QUERY
+          SQL_QUERY
+        end
       end
     end
   end

data/spec/util_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 require 'appmap/util'
 
-describe AppMap::Util do
+describe AppMap::Util, docker: false do
   let(:subject) { AppMap::Util.method(:scenario_filename) }
   describe 'scenario_filename' do
     it 'leaves short names alone' do

data/test/cli_test.rb

@@ -55,11 +55,13 @@ class CLITest < Minitest::Test
     assert_equal <<~OUTPUT.strip, output.strip
     Class frequency:
     ----------------
-    2	Main
+    1	Main
+    1	IO
 
     Method frequency:
     ----------------
-    2	Main.say_hello
+    1	Main.say_hello
+    1	IO#write
     OUTPUT
   end
 
@@ -79,13 +81,21 @@ class CLITest < Minitest::Test
       "class_frequency": [
         {
           "name": "Main",
-          "count": 2
+          "count": 1
+        },
+        {
+          "name": "IO",
+          "count": 1
         }
       ],
       "method_frequency": [
         {
           "name": "Main.say_hello",
-          "count": 2
+          "count": 1
+        },
+        {
+          "name": "IO#write",
+          "count": 1
         }
       ]
     }

data/test/fixtures/minitest_recorder/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'appmap', git: 'applandinc/appmap-ruby', branch: `git rev-parse --abbrev-ref HEAD`.strip
+gem 'byebug'
+gem 'minitest'

data/test/fixtures/minitest_recorder/appmap.yml

@@ -0,0 +1,3 @@
+name: minitest_recorder
+packages:
+  - path: .

data/test/fixtures/minitest_recorder/lib/hello.rb

@@ -0,0 +1,5 @@
+class Hello
+  def say_hello
+    'Hello!'
+  end
+end

data/test/fixtures/minitest_recorder/test/hello_test.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'appmap/minitest'
+require 'hello'
+
+class HelloTest < ::Minitest::Test
+  def test_hello
+    assert_equal 'Hello!', Hello.new.say_hello
+  end
+end

data/test/fixtures/openssl_recorder/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'appmap', git: 'applandinc/appmap-ruby', branch: `git rev-parse --abbrev-ref HEAD`.strip

data/test/fixtures/openssl_recorder/appmap.yml

@@ -0,0 +1,3 @@
+name: openssl_recorder
+packages:
+  - path: lib

data/test/fixtures/openssl_recorder/lib/openssl_cert_sign.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+# From the manual page https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL.html
+
+require 'openssl'
+
+module Example
+  def Example.sign
+    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
+
+    'tmp/csr_cert.pem'.tap do |fname|
+      open fname, 'w' do |io|
+        io.write csr_cert.to_pem
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  cert_file = Example.sign
+  puts "Wrote cert file #{cert_file}"
+end

data/test/fixtures/openssl_recorder/lib/openssl_encrypt.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# From the manual page https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL.html
+
+require 'openssl'
+
+module Example
+  def Example.encrypt
+    cipher = OpenSSL::Cipher.new 'AES-256-CBC'
+    cipher.encrypt
+    iv = cipher.random_iv
+
+    pwd = 'some hopefully not to easily guessable password'
+    salt = OpenSSL::Random.random_bytes 16
+    iter = 20000
+    key_len = cipher.key_len
+    digest = OpenSSL::Digest::SHA256.new
+
+    key = OpenSSL::PKCS5.pbkdf2_hmac(pwd, salt, iter, key_len, digest)
+    cipher.key = key
+
+    document = 'the document'
+
+    encrypted = cipher.update document
+    encrypted << cipher.final
+    encrypted
+  end
+end
+
+if __FILE__ == $0
+  ciphertext = Example.encrypt
+  require 'base64'
+  puts "Computed ciphertext #{Base64.urlsafe_encode64(ciphertext)}"
+end

data/test/fixtures/openssl_recorder/lib/openssl_key_sign.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# From the manual page https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL.html
+
+require 'appmap'
+require 'openssl'
+require 'openssl/digest'
+
+module Example
+  def Example.sign
+    key = OpenSSL::PKey::RSA.new 2048
+
+    document = 'the document'
+
+    digest = OpenSSL::Digest::SHA256.new
+    key.sign digest, document
+  end
+end
+
+if __FILE__ == $0
+  appmap = AppMap.record do
+    Example.sign
+    puts 'Computed signature'
+  end
+  appmap['metadata'] = [ 'recorder' => __FILE__ ]
+
+  File.write('appmap.json', JSON.generate(appmap))
+end

data/test/fixtures/process_recorder/appmap.yml

@@ -0,0 +1,3 @@
+name: process_recorder
+packages:
+  - path: .

data/test/fixtures/process_recorder/hello.rb

@@ -0,0 +1,9 @@
+require 'appmap/record'
+
+class Hello
+  def say_hello
+    'Hello!'
+  end
+end
+
+Hello.new.say_hello

data/test/minitest_test.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'English'
+
+class MinitestTest < Minitest::Test
+  def perform_test(test_name)
+    Bundler.with_clean_env do
+      Dir.chdir 'test/fixtures/minitest_recorder' do
+        FileUtils.rm_rf 'tmp'
+        system 'bundle config --local local.appmap ../../..'
+        system 'bundle'
+        system({ 'APPMAP' => 'true' }, %(bundle exec ruby -Ilib -Itest test/#{test_name}_test.rb))
+
+        yield
+      end
+    end
+  end
+
+  def test_hello
+    perform_test 'hello' do
+      appmap_file = 'tmp/appmap/minitest/Hello_hello.appmap.json'
+
+      assert File.file?(appmap_file), 'appmap output file does not exist'
+      appmap = JSON.parse(File.read(appmap_file))
+      assert_equal AppMap::APPMAP_FORMAT_VERSION, appmap['version']
+      assert_includes appmap.keys, 'metadata'
+      metadata = appmap['metadata']
+      assert_equal 'minitest_recorder', metadata['app']
+      assert_equal 'minitest', metadata['recorder']['name']
+      assert_equal 'ruby', metadata['language']['name']
+      assert_equal 'Hello', metadata['feature_group']
+      assert_equal 'hello', metadata['feature']
+      assert_equal 'Hello hello', metadata['name']
+    end
+  end
+end

data/test/openssl_test.rb

@@ -0,0 +1,203 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'English'
+
+class OpenSSLTest < Minitest::Test
+  def perform_test(test_name)
+    Bundler.with_clean_env do
+      Dir.chdir 'test/fixtures/openssl_recorder' do
+        FileUtils.rm_rf 'tmp'
+        system 'bundle config --local local.appmap ../../..'
+        system 'bundle'
+        system({ 'APPMAP' => 'true', 'DEBUG' => 'true' }, %(bundle exec ruby lib/openssl_#{test_name}.rb))
+
+        yield
+      end
+    end
+  end
+
+  def test_key_sign
+    perform_test 'key_sign' do
+      appmap_file = 'appmap.json'
+
+      assert File.file?(appmap_file), 'appmap output file does not exist'
+      appmap = JSON.parse(File.read(appmap_file))
+      assert_equal AppMap::APPMAP_FORMAT_VERSION, appmap['version']
+      assert_equal [ { 'recorder' => 'lib/openssl_key_sign.rb' } ], appmap['metadata']
+      assert_equal JSON.parse(<<~JSON), appmap['classMap']
+      [
+        {
+          "name": "lib",
+          "type": "package",
+          "children": [
+            {
+              "name": "Example",
+              "type": "class",
+              "children": [
+                {
+                  "name": "sign",
+                  "type": "function",
+                  "location": "lib/openssl_key_sign.rb:10",
+                  "static": true
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "openssl",
+          "type": "package",
+          "children": [
+            {
+              "name": "OpenSSL",
+              "type": "class",
+              "children": [
+                {
+                  "name": "PKey",
+                  "type": "class",
+                  "children": [
+                    {
+                      "name": "PKey",
+                      "type": "class",
+                      "children": [
+                        {
+                          "name": "sign",
+                          "type": "function",
+                          "location": "OpenSSL::PKey::PKey#sign",
+                          "static": false,
+                          "labels": [
+                            "security",
+                            "crypto"
+                          ]
+                        }
+                      ]
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "io",
+          "type": "package",
+          "children": [
+            {
+              "name": "IO",
+              "type": "class",
+              "children": [
+                {
+                  "name": "write",
+                  "type": "function",
+                  "location": "IO#write",
+                  "static": false,
+                  "labels": [
+                    "io"
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      ]
+      JSON
+      sanitized_events = appmap['events'].map(&:deep_symbolize_keys).map(&AppMap::Util.method(:sanitize_event)).map do |event|
+        delete_value = ->(obj) { (obj || {}).delete(:value) }
+        delete_value.call(event[:receiver])
+        delete_value.call(event[:return_value])
+        event
+      end
+
+      diff = Diffy::Diff.new(<<~JSON.strip, JSON.pretty_generate(sanitized_events).strip)
+      [
+        {
+          "id": 1,
+          "event": "call",
+          "defined_class": "Example",
+          "method_id": "sign",
+          "path": "lib/openssl_key_sign.rb",
+          "lineno": 10,
+          "static": true,
+          "parameters": [
+      
+          ],
+          "receiver": {
+            "class": "Module"
+          }
+        },
+        {
+          "id": 2,
+          "event": "call",
+          "defined_class": "OpenSSL::PKey::PKey",
+          "method_id": "sign",
+          "path": "OpenSSL::PKey::PKey#sign",
+          "static": false,
+          "parameters": [
+            {
+              "name": "arg",
+              "class": "OpenSSL::Digest::SHA256",
+              "value": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+              "kind": "req"
+            },
+            {
+              "name": "arg",
+              "class": "String",
+              "value": "the document",
+              "kind": "req"
+            }
+          ],
+          "receiver": {
+            "class": "OpenSSL::PKey::RSA"
+          }
+        },
+        {
+          "id": 3,
+          "event": "return",
+          "parent_id": 2,
+          "return_value": {
+            "class": "String"
+          }
+        },
+        {
+          "id": 4,
+          "event": "return",
+          "parent_id": 1,
+          "return_value": {
+            "class": "String"
+          }
+        },
+        {
+          "id": 5,
+          "event": "call",
+          "defined_class": "IO",
+          "method_id": "write",
+          "path": "IO#write",
+          "static": false,
+          "parameters": [
+            {
+              "name": "arg",
+              "class": "String",
+              "value": "Computed signature",
+              "kind": "rest"
+            }
+          ],
+          "receiver": {
+            "class": "IO"
+          }
+        },
+        {
+          "id": 6,
+          "event": "return",
+          "parent_id": 5,
+          "return_value": {
+            "class": "Integer"
+          }
+        }
+      ]
+      JSON
+      assert_equal '', diff.to_s
+    end
+  end
+end