MuranoCLI 3.2.1.pre.beta.4 → 3.2.1.pre.beta.5

data/spec/webmock_snapshot.rb

@@ -0,0 +1,296 @@
+# Copyright © 2016-2017 Exosite LLC. All Rights Reserved
+# License: PROPRIETARY. See LICENSE.txt.
+# frozen_string_literal: true
+
+# vim:tw=0:ts=2:sw=2:et:ai
+# Unauthorized copying of this file is strictly prohibited.
+
+require 'json'
+require 'net/http'
+require 'singleton'
+require 'webmock'
+
+require 'MrMurano/verbosing'
+require 'MrMurano/Config'
+require 'MrMurano/HttpAuthed'
+
+module Net
+  class HTTP
+    alias old_request request
+    def request(request, body=nil, &block)
+      response = old_request(request, body, &block)
+
+      # If we loaded the request and response from a snapshot already, return
+      # now; otherwise, continue along and add the request-response to our list
+      # of mocks for this example.
+      return response unless MrMurano::Snapshot::WebMock.instance.rebuilding
+
+      req_body = body || ''
+
+      begin
+        resp_status = response.code.to_i
+        if response.body.class == Net::ReadAdapter
+          # See note in read_body monkey patch (below) why we do this.
+          resp_body = response.was_body
+        else
+          resp_body = response.body || ''
+        end
+      rescue NoMethodError
+        resp_status = 200
+        resp_body = response || ''
+      end
+
+      MrMurano::Snapshot::WebMock.instance.record_mock(
+        request.method.downcase.to_sym,
+        request.uri.to_s,
+        req_body,
+        resp_status,
+        resp_body,
+      )
+
+      response
+    end
+  end
+end
+
+module Net
+  module WebMockHTTPResponse
+    attr_reader :was_body
+    # (lb): This feels like more of a hack then these monkey patches already are!
+    # - On read_body() (using a &block to process an HTTP stream), WebMockHTTPResponse
+    # translates the body from a String into a Net::ReadAdapter -- and it doesn't seem
+    # like we can read the body after the block processes it! So here we grab the body
+    # before it's converted into a ReadAdapter. Amazingly, this code appears to work!!
+    alias old_read_body read_body
+    def read_body(dest=nil, &block)
+      @was_body = @body if block_given?
+      old_read_body(dest, &block)
+    end
+  end
+end
+
+module MrMurano
+  class Config
+    alias old_load load
+    def load
+      old_load
+      snapshotter = MrMurano::Snapshot::WebMock.instance
+      return unless snapshotter.snapshot_ready
+      snapshotter.load_example_meta_to_cfg
+    end
+  end
+end
+
+module MrMurano
+  module Snapshot
+    class WebMock
+      include Singleton
+
+      attr_reader :rebuilding
+      attr_reader :snapshot_ready
+
+      def reset(example)
+        @example = example
+        @rebuilding = false
+        @snapshot_name = @example.full_description
+        @snapshot_ready = File.exist?(snapshot_path)
+        ::WebMock.reset!
+        MrMurano::HttpAuthed.instance.credentials_reset
+        MrMurano::HttpAuthed.instance.http_reset
+        ENV.delete('MURANO_TOKEN')
+      end
+
+      # ***
+
+      def establish_mocks
+        @did_allow_net_connect = ::WebMock::Config.instance.allow_net_connect != false
+        snap_path = ensure_snapshot_dirs
+        if @snapshot_ready
+          ::WebMock.disable_net_connect!
+          load_web_mocks(snap_path)
+          @rebuilding = false
+        else
+          # (lb) Note that there's something funky with WebMock and
+          # Net::HTTP.new ... http.start, but I don't think we need
+          # to worry. If we did, look at this WebMock option:
+          #   ::WebMock.allow_net_connect!(net_http_connect_on_start: true)
+          ::WebMock.allow_net_connect!
+          ready_to_sniff
+          @rebuilding = true
+        end
+      end
+
+      def terminate_mocks
+        @example = nil
+        @rebuilding = false
+        if @snapshot_ready
+          ::WebMock.reset!
+        else
+          write_mocks_file
+        end
+        @snapshot_name = nil
+        @snapshot_ready = false
+        restore_allow_net_connect
+      end
+
+      def restore_allow_net_connect
+        if @did_allow_net_connect
+          ::WebMock.allow_net_connect!
+        else
+          ::WebMock.disable_net_connect!
+        end
+        remove_instance_variable(:@did_allow_net_connect)
+      end
+
+      # ***
+
+      def load_web_mocks(snap_path)
+        mock_meta = load_snapshot_json(snap_path)
+        setup_mocks(mock_meta)
+      end
+
+      def load_snapshot_json(snap_path)
+        JSON.parse(File.read(snap_path), symbolize_names: false)
+      rescue JSON::ParserError => err
+        RSpec.configuration.reporter.message(
+          %(ERROR: Invalid JSON for snapshot found at: ‘#{snap_path}’)
+        )
+        RSpec.configuration.reporter.message err.to_s
+        exit 2
+      end
+
+      def setup_mocks(mock_meta)
+        mock_meta.reject { |k, _v| k == 'ex_meta' }.each do |method, requests|
+          requests.each do |req_uri, req_body_and_resp|
+            req_body_and_resp.each do |req_body, resp_metas|
+              setup_web_mock(method, req_uri, req_body, resp_metas)
+            end
+          end
+        end
+
+        @example_meta = mock_meta['ex_meta']
+        load_example_meta_to_cfg
+      end
+
+      def load_example_meta_to_cfg
+        ENV['MURANO_TOKEN'] = @example_meta['MURANO_TOKEN']
+        $cfg.set('net.protocol', @example_meta['net.protocol'], :internal)
+        $cfg.set('net.host', @example_meta['net.host'], :internal)
+        $cfg.set('user.name', @example_meta['user.name'], :internal)
+        $cfg.set('business.id', @example_meta['business.id'], :internal)
+      end
+
+      def setup_web_mock(method, uri, _req_body, resp_metas)
+        responses = []
+        resp_metas.each do |resp_meta|
+          responses.push(
+            status: resp_meta['resp_status'],
+            # Unpack Base64. See pack('m') for comment.
+            body: resp_meta['resp_body'].unpack('m')[0],
+            headers: {}
+          )
+        end
+        @example.example_group_instance.stub_request(
+          method.to_sym,
+          uri,
+        # (lb): We might eventually need to add the request body to the mock,
+        # but as of 2018-08-09 I've yet to see a non-empty request body.
+        #   ).with(
+        #     body: req_body,
+        ).to_return(
+          *responses
+        )
+      end
+
+      # ***
+
+      def ready_to_sniff
+        @curr_meta = {}
+        @curr_meta['ex_meta'] = {}
+      end
+
+      def record_mock(method, uri, req_body, resp_status, resp_body)
+        encoded_body = encode_for_json(resp_body)
+        mock_response = {
+          'resp_body': encoded_body,
+          'resp_status': resp_status,
+        }
+        @curr_meta[method] ||= {}
+        @curr_meta[method][uri] ||= {}
+        @curr_meta[method][uri][req_body] ||= []
+        @curr_meta[method][uri][req_body].push(mock_response)
+      end
+
+      def encode_for_json(resp_body)
+        # Avoid problems encoding to JSON by encoding the response body now.
+        # NOTE: 'm' packs as Base64. See:
+        #   https://ruby-doc.org/core-2.3.3/Array.html#method-i-pack
+        encoded_body = [resp_body].pack('m')
+        # DEVS: Uncomment this to see the difference between the raw and encoded value:
+        #  require 'byebug' ; byebug if encoded_body != resp_body
+        encoded_body
+      end
+
+      # ***
+
+      def write_mocks_file
+        RSpec.configuration.reporter.message "Saving mock sniff to: #{snapshot_path}"
+
+        @curr_meta['ex_meta']['MURANO_TOKEN'] = MrMurano::HttpAuthed.instance.token_biz
+        @curr_meta['ex_meta']['net.protocol'] = $cfg['net.protocol']
+        @curr_meta['ex_meta']['net.host'] = $cfg['net.host']
+        @curr_meta['ex_meta']['user.name'] = $cfg['user.name']
+        @curr_meta['ex_meta']['business.id'] = $cfg['business.id']
+
+        mocks_file = File.new(snapshot_path, 'w+')
+        MrMurano::Verbose.dump_file_json(@curr_meta, mocks_file, pretty: true)
+        mocks_file.close
+
+        @curr_meta = nil
+      end
+
+      # ***
+
+      def resolve_var(ex_meta_key, ex_meta_value)
+        if @rebuilding
+          @curr_meta['ex_meta'][ex_meta_key] = ex_meta_value
+          ex_meta_value
+        else
+          @example_meta[ex_meta_key]
+        end
+      end
+
+      # ***
+
+      def ensure_snapshot_dirs
+        snap_path = snapshot_path
+        basedir = File.dirname(snap_path)
+        FileUtils.mkdir_p(basedir) unless File.directory?(basedir)
+        snap_path
+      end
+
+      def snapshot_dir
+        if RSpec.configuration.snapshot_dir == :relative
+          # (lb): This path is pretty useless: We generally make a
+          # Murano CLI project under /tmp and chdir there before
+          # this method is called, so the snapshot directory would
+          # be created under /tmp!
+          File.dirname(@example.file_path) << '/__snapshots__'
+        else
+          RSpec.configuration.snapshot_dir
+        end
+      end
+
+      def snapshot_file
+        "#{@snapshot_name}.webmock"
+      end
+
+      def snapshot_path
+        File.join(snapshot_dir, snapshot_file)
+      end
+    end
+
+    RSpec.configuration.add_setting(:snapshot_dir, default: :relative)
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: MuranoCLI
 version: !ruby/object:Gem::Version
-  version: 3.2.1.pre.beta.4
+  version: 3.2.1.pre.beta.5
 platform: ruby
 authors:
 - Michael Conrad Tadpol Tilstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2018-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: certified
@@ -467,6 +467,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- HISTORY.md
 - LICENSE.txt
 - MuranoCLI.gemspec
 - MuranoCLI.iss
@@ -491,6 +492,7 @@ files:
 - docs/completions/murano_completion-bash
 - docs/demo.md
 - docs/develop.rst
+- docs/release.rst
 - lib/MrMurano.rb
 - lib/MrMurano/Account.rb
 - lib/MrMurano/AccountBase.rb
@@ -661,6 +663,134 @@ files:
 - spec/fixtures/product_spec_files/lightbulb-no-state.yaml
 - spec/fixtures/product_spec_files/lightbulb.yaml
 - spec/fixtures/roles-three.yaml
+- spec/fixtures/snapshots/murano application setting Writes (using Webservice.cors)
+  a bool value 0.webmock
+- spec/fixtures/snapshots/murano application setting Writes (using Webservice.cors)
+  a bool value 1.webmock
+- spec/fixtures/snapshots/murano application setting Writes (using Webservice.cors)
+  a bool value No.webmock
+- spec/fixtures/snapshots/murano application setting Writes (using Webservice.cors)
+  a bool value Yes.webmock
+- spec/fixtures/snapshots/murano application setting Writes (using Webservice.cors)
+  a bool value bob.webmock
+- spec/fixtures/snapshots/murano application setting Writes (using Webservice.cors)
+  a bool value false.webmock
+- spec/fixtures/snapshots/murano application setting Writes (using Webservice.cors)
+  a bool value off.webmock
+- spec/fixtures/snapshots/murano application setting Writes (using Webservice.cors)
+  a bool value on STDIN.webmock
+- spec/fixtures/snapshots/murano application setting Writes (using Webservice.cors)
+  a bool value on.webmock
+- spec/fixtures/snapshots/murano application setting Writes (using Webservice.cors)
+  a bool value true.webmock
+- spec/fixtures/snapshots/murano application setting Writes (using Webservice.cors)
+  a json array blob with STDIN.webmock
+- spec/fixtures/snapshots/murano application setting Writes (using Webservice.cors)
+  a json array blob.webmock
+- spec/fixtures/snapshots/murano application setting Writes (using Webservice.cors)
+  an array.webmock
+- spec/fixtures/snapshots/murano application setting Writes (using Webservice.cors)
+  appends an array.webmock
+- spec/fixtures/snapshots/murano application setting reads Webservice.cors to a file.webmock
+- spec/fixtures/snapshots/murano application setting reads Webservice.cors.webmock
+- spec/fixtures/snapshots/murano business list as json.webmock
+- spec/fixtures/snapshots/murano business list as table.webmock
+- spec/fixtures/snapshots/murano business list fewer fields.webmock
+- spec/fixtures/snapshots/murano business list only ids.webmock
+- spec/fixtures/snapshots/murano business list output to file.webmock
+- spec/fixtures/snapshots/murano business without project help.webmock
+- spec/fixtures/snapshots/murano config Needs a key.webmock
+- spec/fixtures/snapshots/murano config Reads a key.webmock
+- spec/fixtures/snapshots/murano config Removes a key.webmock
+- spec/fixtures/snapshots/murano config Sets a key.webmock
+- spec/fixtures/snapshots/murano config Sets a user key.webmock
+- spec/fixtures/snapshots/murano content life cycle.webmock
+- spec/fixtures/snapshots/murano cors sets CORS.webmock
+- spec/fixtures/snapshots/murano cors show CORS.webmock
+- spec/fixtures/snapshots/murano device activates.webmock
+- spec/fixtures/snapshots/murano device enables a batch.webmock
+- spec/fixtures/snapshots/murano device enables and lists.webmock
+- spec/fixtures/snapshots/murano device writes and reads.webmock
+- spec/fixtures/snapshots/murano domain show domain.webmock
+- spec/fixtures/snapshots/murano element edit unknown as unknown element.webmock
+- spec/fixtures/snapshots/murano element show --help.webmock
+- spec/fixtures/snapshots/murano element show as csv.webmock
+- spec/fixtures/snapshots/murano element show as default-table.webmock
+- spec/fixtures/snapshots/murano element show as json.webmock
+- spec/fixtures/snapshots/murano element show as table truncate.webmock
+- spec/fixtures/snapshots/murano element show as table wrap.webmock
+- spec/fixtures/snapshots/murano element show as yaml.webmock
+- spec/fixtures/snapshots/murano element show using ambiguous name.webmock
+- spec/fixtures/snapshots/murano element without project usage.webmock
+- spec/fixtures/snapshots/murano exchange with project list as json.webmock
+- spec/fixtures/snapshots/murano exchange with project list as table.webmock
+- spec/fixtures/snapshots/murano exchange with project list fewer fields.webmock
+- spec/fixtures/snapshots/murano exchange with project list only ids.webmock
+- spec/fixtures/snapshots/murano exchange with project list output to file.webmock
+- spec/fixtures/snapshots/murano exchange with project list purchase is already added
+  ID.webmock
+- spec/fixtures/snapshots/murano exchange with project list purchase is ambiguous
+  name.webmock
+- spec/fixtures/snapshots/murano exchange without project help.webmock
+- spec/fixtures/snapshots/murano help using commander as --help.webmock
+- spec/fixtures/snapshots/murano help using commander no args.webmock
+- spec/fixtures/snapshots/murano help using subshell no args.webmock
+- spec/fixtures/snapshots/murano help using subshell with --help.webmock
+- spec/fixtures/snapshots/murano init Won't init in HOME (gracefully).webmock
+- spec/fixtures/snapshots/murano init in empty directory with existing project.webmock
+- spec/fixtures/snapshots/murano init in empty directory without existing project.webmock
+- spec/fixtures/snapshots/murano init in existing project directory with ProjectFile.webmock
+- spec/fixtures/snapshots/murano init in existing project directory with SolutionFile
+  0.2.0.webmock
+- spec/fixtures/snapshots/murano init in existing project directory with SolutionFile
+  0.3.0.webmock
+- spec/fixtures/snapshots/murano init in existing project directory without ProjectFile.webmock
+- spec/fixtures/snapshots/murano keystore can call other commands.webmock
+- spec/fixtures/snapshots/murano keystore clearAll.webmock
+- spec/fixtures/snapshots/murano keystore deletes.webmock
+- spec/fixtures/snapshots/murano keystore gets.webmock
+- spec/fixtures/snapshots/murano keystore infos.webmock
+- spec/fixtures/snapshots/murano keystore lists.webmock
+- spec/fixtures/snapshots/murano link with project links and lists.webmock
+- spec/fixtures/snapshots/murano link with project unlinks.webmock
+- spec/fixtures/snapshots/murano link without project help.webmock
+- spec/fixtures/snapshots/murano link without project subshell vs inline using commander
+  will not list.webmock
+- spec/fixtures/snapshots/murano link without project subshell vs inline using subshell
+  will not list.webmock
+- spec/fixtures/snapshots/murano logs when project is setup tail log.webmock
+- spec/fixtures/snapshots/murano password Lists when no file.webmock
+- spec/fixtures/snapshots/murano password deletes a password.webmock
+- spec/fixtures/snapshots/murano password sets a password.webmock
+- spec/fixtures/snapshots/murano product setting Writes (using Device2.identity_format)
+  a forced string value on STDIN.webmock
+- spec/fixtures/snapshots/murano product setting Writes (using Device2.identity_format)
+  a forced string value.webmock
+- spec/fixtures/snapshots/murano product setting Writes (using Device2.identity_format)
+  a number value fiftyHalf.webmock
+- spec/fixtures/snapshots/murano product setting Writes (using Device2.identity_format)
+  a number value float 12.67.webmock
+- spec/fixtures/snapshots/murano product setting Writes (using Device2.identity_format)
+  a number value integer 12.webmock
+- spec/fixtures/snapshots/murano product setting Writes (using Device2.identity_format)
+  a number value on STDIN.webmock
+- spec/fixtures/snapshots/murano product setting Writes (using Device2.identity_format)
+  a string value.webmock
+- spec/fixtures/snapshots/murano product setting Writes (using Device2.identity_format)
+  merges into a dictionary.webmock
+- spec/fixtures/snapshots/murano single sync without ProjectFile syncdown.webmock
+- spec/fixtures/snapshots/murano status with ProjectFile status.webmock
+- spec/fixtures/snapshots/murano status with Solutionfile 0.2.0 status.webmock
+- spec/fixtures/snapshots/murano status with Solutionfile 0.3.0 status.webmock
+- spec/fixtures/snapshots/murano status without ProjectFile matches file path.webmock
+- spec/fixtures/snapshots/murano status without ProjectFile matches route.webmock
+- spec/fixtures/snapshots/murano status without ProjectFile status.webmock
+- spec/fixtures/snapshots/murano syncdown stubbed without ProjectFile syncdown.webmock
+- spec/fixtures/snapshots/murano syncdown without ProjectFile syncdown.webmock
+- spec/fixtures/snapshots/murano syncup without ProjectFile syncup.webmock
+- spec/fixtures/snapshots/murano token with project list as table.webmock
+- spec/fixtures/snapshots/murano token without project help.webmock
+- spec/fixtures/snapshots/murano usage show usage.webmock
 - spec/fixtures/syncable_conflict/services/devdata.lua
 - spec/fixtures/syncable_conflict/services/timers.lua
 - spec/fixtures/syncable_content/assets/icon.png
@@ -679,6 +809,7 @@ files:
 - spec/fixtures/websocket/wss-fake-logs.rb
 - spec/spec_helper.rb
 - spec/variegated_TruthyFalsey_spec.rb
+- spec/webmock_snapshot.rb
 homepage: https://github.com/exosite/MuranoCLI
 licenses:
 - MIT