snow_sync 3.1.2 → 3.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7d72e4b145e73ab7e226651173c037d5e104aa06
-  data.tar.gz: c94c90bda93ccd9680bb0e4bc641030fe1ae75fb
+SHA256:
+  metadata.gz: 006d22f37ee45ef3de904baba95ba0ee0e6a80dc25259741bbab58e9e34db4ee
+  data.tar.gz: 0e31d3394fc906562060141146dc15032c8701d7da5ec76495b9cc7d17e68bd6
 SHA512:
-  metadata.gz: 07568e10689e39c77d50aac5dc8dd9a73f9f4fda63ebb8e02bd930ff231c16f0eafad56d8240ffcb816e6fa58a37c93f8aece453278ae0b56e0995970d46fa5f
-  data.tar.gz: d536814539b196f09019e80eeb2c004fbe10db7ebab8cf6566ede6cd93c045462ea9b8e129b0ed5bcc39de5d69e182be330b156380eddd4eb881ee05720bd98b
+  metadata.gz: f45e339f65b62bc897d697b1bb46f442cbb6a48f5ab6728701d7d1415efa91223725db708237b7637e8c34c8ad756b18d309a10a6a2a78ffeb3cc4c452637fe6
+  data.tar.gz: 4e3701f3d65594d6d284b99e86f8694d9565e87546570440ba89842163c1a1493aecdbbbc10e9ee755369f5e6a2ce66c351947b584b3d8bca5b8d9c13c640a20

data/README.md

@@ -1,6 +1,6 @@
 # SnowSync
 
-[![Gem Version](https://img.shields.io/badge/gem-v3.1.2-brightgreen.svg)](https://rubygems.org/gems/snow_sync) [![Dependency Status](https://img.shields.io/badge/dependencies-up--to--date-blue.svg)](https://rubygems.org/gems/snow_sync) [![Downloads](https://img.shields.io/badge/downloads-5k%2B-lightgrey.svg)](https://rubygems.org/gems/snow_sync)
+[![Gem Version](https://img.shields.io/badge/gem-v3.1.5-brightgreen.svg)](https://rubygems.org/gems/snow_sync) [![Dependency Status](https://img.shields.io/badge/dependencies-up--to--date-blue.svg)](https://rubygems.org/gems/snow_sync) [![Downloads](https://img.shields.io/badge/downloads-25k%2B-lightgrey.svg)](https://rubygems.org/gems/snow_sync)
 
 SnowSync is a file sync utility tool and API which provides a bridge for off platform ServiceNow development using an IDE or text editor locally.
 
@@ -9,15 +9,15 @@ SnowSync syncronizes configured fields (scripts) for a ServiceNow instance local
 ## Installation
 
 ```bash
-mkdir snow_sync
+mkdir snow-sync
 ```
 
 ```bash
-cd snow_sync
+cd snow-sync
 ```
 
 ```ruby
-gem install --install-dir <path-to-the-snow_sync-dir> snow_sync
+gem install --install-dir <path-to-the-snow-sync-dir> snow_sync
 ```
 
 ## Setup & Usage
@@ -30,19 +30,27 @@ gem install bundler
 cd <path-to-the-snow_sync-dir>/gems/snow_sync-<version>
 ```
 
+OSX users run the following command:
+
+```bash
+brew install terminal-notifier
+```
+
 Create a Gemfile and add the following Gem dependencies:
 
 ```ruby
-source 'https://rubygems.org'
-gem 'facets', '~> 3.1.0'
-gem 'guard', '~> 2.14.0'
-gem 'guard-yield', '~> 0.1.0'
-gem 'json', '>= 1.8.3', '~> 1.8.0'
-gem 'libnotify', '~> 0.9.1'
-gem 'rake', '~> 10.0.0'
-gem 'rest-client', '~> 2.0.0'
-gem 'rspec', '~> 3.5.0'
-gem 'thor', '0.19.1'
+source "https://rubygems.org"
+gem "facets", "~> 3.1.0"
+gem "guard", "~> 2.14.0"
+gem "guard-yield", "~> 0.1.0"
+gem "json", "~> 2.6.1"
+gem "libnotify", "~> 0.9.2"
+gem "rake", "~> 13.0.6"
+gem "rest-client", "~> 2.0.0"
+gem "rspec", "~> 3.10.0"
+gem "rspec-core", "~> 3.10.1"
+gem "terminal-notifier-guard", "~> 1.7"
+gem "thor", "0.19.1"
 ```
 
 ```bash
@@ -54,12 +62,12 @@ cd /lib/snow_sync
 ```
 
 * Setup the configurations in the configs.yml
-* Now supports multi-table map configurations
-* Configuration path is the current working directory
+* Supports multi-table map configurations
+* YAML configuration path is the current working directory
 * Append /api/now/table/ to the base_url
 
 ```bash
-guard -i
+bundle exec guard -i
 ```
 
 **Note:** if the sync directory is deleted after a successful sync, reset the credential configs in the configs.yml so they can be re-encrypted on the next sync
@@ -68,17 +76,22 @@ guard -i
 ## Running the Tests
 
 ```bash
-cd <path-to-the-snow_sync-dir>/gems/snow_sync-<version>
+cd <path-to-the-snow-sync-dir>/gems/snow_sync-<version>
 ```
 
-* Integration tests use a test record in the instance (e.g. a script include)
-* Unit tests are all stubbed out
+* Integration tests use a test record in the test instance
 * Setup the test configurations in the test_configs.yml
-* Configuration path is the current working directory
+* YAML configuration path is the current working directory
 * Append /api/now/table/ to the base_url
 
 ```ruby
-rspec spec/sync_util_spec.rb
+bundle exec rspec spec/sync_util_spec.rb
+```
+
+* Unit tests are pure, so they're not externally dependent
+
+```ruby
+bundle exec rspec spec/sync_util_mock_spec.rb
 ```
 
 **Note:** if the sync directory is deleted after a successful sync, reset the credential configs in the test_configs.yml so they can be re-encrypted on the next sync

data/lib/snow_sync/Guardfile

@@ -16,18 +16,19 @@ yield_options = {
     logger.info "Guard::Yield - Done!"
   end,
 
-  run_on_modifications: proc do |log, _, files|
-    log.info "!!: #{files * ','}"
+  run_on_modifications: proc do |logger, _, files|
     @util.push_modifications(files)
-    @util.notify(files, log)
+    logger.info "!!: #{files}"
+    uname = `uname`.chomp.downcase
+    @util.notify(files, uname, logger)
   end,
 
-  run_on_additions: proc do |log, _, files| 
-    log.info "++: #{files * ','}" 
+  run_on_additions: proc do |logger, _, files| 
+    logger.info "++: #{files}"
   end,
 
-  run_on_removals: proc do |log, _, files|
-    log.warn "xx: #{files * ','}"
+  run_on_removals: proc do |logger, _, files|
+    logger.warn "xx: #{files}"
   end,
 
 }

data/lib/snow_sync/configs.yml

@@ -6,6 +6,7 @@ base_url:
 creds: 
   user:
   pass:
+  encrypted:
 
 table_map:
   script_include:

data/lib/snow_sync/sync_util.rb

@@ -75,8 +75,7 @@ module SnowSync
     # Encrypts config credentials based on previous sync
 
     def encrypt_credentials
-      previous_sync = File.directory?("sync")
-      if !previous_sync
+      unless @configs["creds"]["encrypted"]
         configs_path = @configs["conf_path"] + @cf
         configs = YAML::load_file(configs_path)
         # local configuration changes
@@ -84,10 +83,12 @@ module SnowSync
         passb64 = Base64.strict_encode64(@configs["creds"]["pass"])
         configs["creds"]["user"] = userb64
         configs["creds"]["pass"] = passb64
+        configs["creds"]["encrypted"] = true
         File.open(configs_path, 'w') { |f| YAML::dump(configs, f) }
         # object state configuration changes
         @configs["creds"]["user"] = userb64
 	@configs["creds"]["pass"] = passb64
+        @configs["creds"]["encrypted"] = true
       end
     end
 
@@ -155,9 +156,8 @@ module SnowSync
     # Merges JS file changes with the encapsulated table response value
     # @param [String] type Config table label
     # @param [String] file JS file by name
-    # @param [Hash] table_hash Configured servicenow table hash
 
-    def merge_update(type, file, table_hash)
+    def merge_update(type, file)
       FileUtils.cd("sync" + "/" + type)
       script_body = File.open(file).read
       @configs["table_map"][type]["mod"] = script_body
@@ -182,7 +182,7 @@ module SnowSync
         type = path[1]
         file = path[2]
         table_hash = table_lookup(type, file)
-        merge_update(type, file, table_hash)
+        merge_update(type, file)
         begin
           user = Base64.strict_decode64(@configs["creds"]["user"])
           pass = Base64.strict_decode64(@configs["creds"]["pass"])
@@ -201,22 +201,22 @@ module SnowSync
 
     # Dispatches osx & linux platform notification when file updates are pushed
     # @param [Array] update File updated
-    # @param [Object] log Log Object
+    # @param [String] uname Operating system name
+    # @param [Object] logger Logger object
 
-    def notify(update, log)
-      if `uname` =~ /Darwin/
+    def notify(update, uname, logger)
+      if uname =~ /darwin/
         TerminalNotifier::Guard.success(
-          "File: #{update * ','}",
+          "File: #{update}",
           :title => "ServiceNow Script Update"
         )
-        log.info "->: osx notification dispatched"
-      elsif `uname` =~ /Linux/
+        logger.info "->: osx notification dispatched"
+      elsif uname =~ /linux/
         Libnotify.show(
           :summary => "ServiceNow Script Update",
-          :body => "File: #{update * ','}",
-          :timeout => 1.5
+          :body => "File: #{update}"
         )
-        log.info "->: linux notification dispatched"
+        logger.info "->: linux notification dispatched"
       end
     end
 

data/lib/snow_sync/version.rb

@@ -1,3 +1,3 @@
 module SnowSync
-  VERSION = "3.1.2"
+  VERSION = "3.1.6"
 end

data/spec/docker_install_spec.rb

@@ -0,0 +1,30 @@
+describe "Dockerfile" do
+
+  def run_os_check(command)
+    `#{command}`.downcase
+  end
+
+  it "installs the right version of Ubuntu" do
+    os = "ubuntu"
+    version = "20.04"
+    installation = run_os_check('lsb_release -a')
+    expect(installation).to include(os)
+    expect(installation).to include(version)
+  end
+
+  it "installs vim" do
+    installation = run_os_check('vim --version')
+    expect(installation).to include('vim - vi')
+  end
+
+  it "installs git" do
+    installation = run_os_check('git version')
+    expect(installation).to include('git version')
+  end
+
+  it "installs ruby" do
+    installation = run_os_check('ruby -v')
+    expect(installation).to include('ruby')
+  end
+ 
+end

data/spec/spec_helper.rb

@@ -5,8 +5,8 @@ RSpec.configure do |config|
   require "json"
   require_relative "../lib/snow_sync/sync_util.rb"
 
-  @util = SnowSync::SyncUtil.new(opts = "test")
-  @util.encrypt_credentials
+  config.color
+  config.formatter = :documentation
 
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true

data/spec/sync_util_mock_spec.rb

@@ -0,0 +1,549 @@
+require "spec_helper"
+
+describe "#initialize" do
+
+  before do
+    allow(YAML).to receive(:load_file)
+    allow(Logger).to receive(:new)
+  end
+
+  it "should construct an instance" do
+    SnowSync::SyncUtil.new(opts = "test")
+    expect(YAML).to have_received(:load_file).with("test_configs.yml")
+    expect(Logger).to have_received(:new).with(STDERR)
+  end 
+
+end
+
+describe "#create_directory" do
+
+  let :util do
+    SnowSync::SyncUtil.new(opts = "test")
+  end
+
+  let :logger do
+    instance_double(Logger)
+  end
+
+  let :dir_name do
+    "sync"
+  end
+
+  before do
+    allow(File).to receive(:directory?).and_return(false)
+    allow(FileUtils).to receive(:mkdir_p)
+    allow(Logger).to receive(:new).and_return(logger)
+    allow(logger).to receive(:info)
+  end
+
+  it "should create a directory" do
+    util.create_directory(dir_name)
+    expect(File).to have_received(:directory?).with(dir_name)
+    expect(FileUtils).to have_received(:mkdir_p).with(dir_name)
+    expect(logger).to have_received(:info).with("++: #{dir_name}")
+  end
+
+end
+
+describe "#create_subdirectory" do
+
+  let :util do
+    SnowSync::SyncUtil.new(opts = "test")
+  end
+
+  let :path do
+    proc { FileUtils.cd("sync") }
+  end
+
+  let :sub_dir_name do
+    "sub-dir-of-sync"
+  end
+
+  before do
+    allow_any_instance_of(SnowSync::SyncUtil).to receive(:create_directory)
+      .and_return("++: #{sub_dir_name}")
+  end
+
+  it "should create a subdirectory" do
+    expect(util.create_subdirectory(sub_dir_name, &path)).to eq("++: #{sub_dir_name}")
+  end
+
+end
+
+describe "#create_file" do
+
+  let :util do
+    SnowSync::SyncUtil.new(opts = "test")
+  end
+
+  let :logger do
+    instance_double(Logger)
+  end
+
+  let :file_name do
+    "test_file"
+  end
+
+  let :json do
+    { "test-json": "testing" }
+  end
+
+  let :path do
+    proc { }
+  end
+
+  before do
+    allow(File).to receive(:open).and_call_original
+    allow(Logger).to receive(:new).and_return(logger)
+    allow(logger).to receive(:info)
+  end
+
+  after do
+    test_file = `ls`.split("\n").pop
+    FileUtils.rm_rf(test_file)
+  end
+
+  it "should create a js file" do
+    util.create_file(file_name, json, &path)
+    expect(File).to have_received(:open).with(file_name + ".js", "w")
+    expect(logger).to have_received(:info).with("->: #{file_name}" + ".js")
+    expect(`ls`.split("\n").pop).to eq("test_file.js")
+    expect(File.open("#{file_name}.js").read).to eq("{:\"test-json\"=>\"testing\"}")
+  end
+
+end
+
+describe "#check_required_configs" do
+
+  let :util do
+    SnowSync::SyncUtil.new(opts = "test")
+  end
+
+  it "should raise an exception when there is no config path" do
+    util.configs["conf_path"] = nil
+    expect{util.check_required_configs}.to raise_error(
+      /Check the configuration path, base url, credentials or table to sync/)
+  end
+
+  it "should raise an exception when there is no base url" do
+    util.configs["base_url"] = nil
+    expect{util.check_required_configs}.to raise_error(
+      /Check the configuration path, base url, credentials or table to sync/)
+  end
+
+  it "should raise an exception when there is no username" do
+    util.configs["creds"]["user"] = nil
+    expect{util.check_required_configs}.to raise_error(
+      /Check the configuration path, base url, credentials or table to sync/)
+  end
+
+  it "should raise an exception when there is no password" do
+    util.configs["creds"]["pass"] = nil
+    expect{util.check_required_configs}.to raise_error(
+      /Check the configuration path, base url, credentials or table to sync/)
+  end
+
+  it "should raise an exception when there are no tables mapped" do
+    tables = util.configs["table_map"].keys
+    tables.each do |table|
+      util.configs["table_map"][table]["table"] = nil
+      expect{util.check_required_configs}.to raise_error(
+        /Check the configuration path, base url, credentials or table to sync/)
+    end
+  end
+
+end
+
+describe "#encrypt_credentials" do
+
+  let :util do
+    SnowSync::SyncUtil.new(opts = "test")
+  end
+ 
+  before do
+    FileUtils.touch("spec/test_configs.yml")
+    local_configs = {
+      "conf_path" => "spec/",
+      "base_url" => nil,
+      "creds" => {
+        "user" => "test-name",
+        "pass" => "test-password",
+        "encrypted" => false
+      }
+    }  
+    allow(YAML).to receive(:load_file).and_return(local_configs)
+    allow(Base64).to receive(:strict_encode64).and_call_original
+    allow(File).to receive(:open).and_call_original
+  end
+
+  after do
+    FileUtils.rm_rf("spec/test_configs.yml")
+  end
+
+  it "should encrypt credentials" do
+    util.configs["conf_path"] = "spec/"
+    util.configs["creds"]["user"] = "test-name"
+    util.configs["creds"]["pass"] = "test-password"
+    util.encrypt_credentials
+    expect(YAML).to have_received(:load_file).with("spec/test_configs.yml")
+    allow(Base64).to receive(:strict_encode64).twice
+    expect(File).to have_received(:open).with("spec/test_configs.yml", "w")
+    # configs object state updates
+    expect(util.configs["creds"]["user"]).to eq("dGVzdC1uYW1l")
+    expect(util.configs["creds"]["pass"]).to eq("dGVzdC1wYXNzd29yZA==")
+    expect(util.configs["creds"]["encrypted"]).to eq(true)
+    # test configs file updates
+    encrypted_content = YAML::load_file("spec/test_configs.yml")
+    expect(encrypted_content["creds"]["user"]).to eq("dGVzdC1uYW1l")
+    expect(encrypted_content["creds"]["pass"]).to eq("dGVzdC1wYXNzd29yZA==")
+    expect(encrypted_content["creds"]["encrypted"]).to eq(true)
+  end
+end
+
+describe "#run_setup_and_sync" do
+
+  let :util do
+    SnowSync::SyncUtil.new(opts = "test")
+  end
+
+  let :logger do
+    instance_double(Logger)
+  end
+
+  before do
+    allow(Base64).to receive(:strict_decode64).and_call_original
+    allow(Base64).to receive(:strict_encode64).and_call_original
+    allow(RestClient).to receive(:get).and_return("{\"result\":[{ \"status\": \"200\" }]}")
+    allow(FileUtils).to receive(:cd)
+  end
+
+  it "should run setup & sync - sync directory present path" do
+    # allow not included in 'before' setup to set return bool
+    allow(File).to receive(:directory?).and_return(true)
+    expect_any_instance_of(SnowSync::SyncUtil).to receive(:create_subdirectory)
+    expect_any_instance_of(SnowSync::SyncUtil).to receive(:create_file)
+    util.configs = { "conf_path" => nil, 
+      "base_url" => "https://test.com/api/now/table/",
+      "creds" => {
+        "user" => "dGVzdC1uYW1l", 
+        "pass" => "dGVzdC1wYXNzd29yZA=="
+      },
+      "table_map" => {
+        "script_include" => {
+          "name" => "TestClass",
+          "table" => "sys_script_include", 
+          "sys_id" => "xxxxxx-sysid-xxxxxx",
+          "field" => "test-field"
+        }
+      }
+    }  
+    util.run_setup_and_sync
+    expect(File).to have_received(:directory?).with("sync")
+    expect(Base64).to have_received(:strict_decode64).with("dGVzdC1uYW1l")
+    expect(Base64).to have_received(:strict_decode64).with("dGVzdC1wYXNzd29yZA==")
+    expect(Base64).to have_received(:strict_encode64).with("test-name:test-password")
+    expect(RestClient).to have_received(:get).with(
+      "https://test.com/api/now/table/sys_script_include?sysparm_query=sys_id%3D" +
+      "xxxxxx-sysid-xxxxxx%5Ename%3DTestClass",
+      {:authorization => "Basic " + "dGVzdC1uYW1lOnRlc3QtcGFzc3dvcmQ=",
+       :accept => "application/json"})
+    expect(FileUtils).to have_received(:cd).with("../..")
+  end
+
+  it "should run setup & sync - sync directory not present path" do
+    # allow not included in 'before' setup to set return bool
+    allow(File).to receive(:directory?).and_return(false)
+    expect_any_instance_of(SnowSync::SyncUtil).to receive(:create_directory)
+    expect_any_instance_of(SnowSync::SyncUtil).to receive(:create_subdirectory)
+    expect_any_instance_of(SnowSync::SyncUtil).to receive(:create_file)
+    util.configs = { "conf_path" => nil, 
+      "base_url" => "https://test.com/api/now/table/",
+      "creds" => {
+        "user" => "dGVzdC1uYW1l", 
+        "pass" => "dGVzdC1wYXNzd29yZA=="
+      },
+      "table_map" => {
+        "script_include" => {
+          "name" => "TestClass",
+          "table" => "sys_script_include", 
+          "sys_id" => "xxxxxx-sysid-xxxxxx",
+          "field" => "test-field"
+        }
+      }
+    } 
+    util.run_setup_and_sync
+    expect(File).to have_received(:directory?).with("sync")
+    expect(Base64).to have_received(:strict_decode64).with("dGVzdC1uYW1l")
+    expect(Base64).to have_received(:strict_decode64).with("dGVzdC1wYXNzd29yZA==")
+    expect(Base64).to have_received(:strict_encode64).with("test-name:test-password")
+    expect(RestClient).to have_received(:get).with(
+      "https://test.com/api/now/table/sys_script_include?sysparm_query=sys_id%3D" +
+      "xxxxxx-sysid-xxxxxx%5Ename%3DTestClass",
+      {:authorization => "Basic " + "dGVzdC1uYW1lOnRlc3QtcGFzc3dvcmQ=",
+       :accept => "application/json"})
+    expect(FileUtils).to have_received(:cd).with("../..")
+  end
+
+  it "should handle an exception" do
+    # allow not included in 'before' setup to set return bool
+    allow(File).to receive(:directory?).and_return(true)
+    expect_any_instance_of(SnowSync::SyncUtil).to receive(:create_subdirectory)
+    allow(RestClient).to receive(:get).and_raise(RestClient::ExceptionWithResponse)
+    allow(Logger).to receive(:new).and_return(logger)
+    allow(logger).to receive(:error)
+    util.configs = { "conf_path" => nil, 
+      "base_url" => "https://test.com/api/now/table/",
+      "creds" => {
+        "user" => "dGVzdC1uYW1l", 
+        "pass" => "dGVzdC1wYXNzd29yZA=="
+      },
+      "table_map" => {
+        "script_include" => {
+          "name" => "TestClass",
+          "table" => "sys_script_include", 
+          "sys_id" => "xxxxxx-sysid-xxxxxx",
+          "field" => "test-field"
+        }
+      }
+    } 
+    util.run_setup_and_sync
+    expect(logger).to have_received(:error)
+      .with("ERROR: RestClient::ExceptionWithResponse").once
+  end
+
+end
+
+describe "#classify" do
+
+  let :util do
+    SnowSync::SyncUtil.new(opts = "test")
+  end
+
+  it "should convert snake_case string to CamelCase" do
+    expect(util.classify("test_class.js")).to eq("TestClass")
+  end
+
+end
+
+describe "#table_lookup" do
+
+  let :util do
+    SnowSync::SyncUtil.new(opts = "test")
+  end 
+
+  it "should return configured SN table" do
+    util.configs = { "conf_path" => nil, 
+      "base_url" => "https://test.com/api/now/table/",
+      "creds" => {
+        "user" => "dGVzdC1uYW1l", 
+        "pass" => "dGVzdC1wYXNzd29yZA=="
+      },
+      "table_map" => {
+        "script_include" => {
+          "name" => "TestClass",
+          "table" => "sys_script_include", 
+          "sys_id" => "xxxxxx-sysid-xxxxxx",
+          "field" => "test-field"
+        }
+      }
+    } 
+    table_map = util.table_lookup("script_include", "test_class.js")
+    expect(table_map == { "name" => "TestClass", 
+      "table" => "sys_script_include", 
+      "sys_id" => "xxxxxx-sysid-xxxxxx",
+      "field" => "test-field"
+    }).to be(true)
+  end
+
+end
+
+describe "#merge_update" do
+
+  let! :util do
+    SnowSync::SyncUtil.new(opts = "test")
+  end
+
+  before do
+    allow(FileUtils).to receive(:cd)
+    allow(File).to receive(:open).and_return(IO)
+    allow(IO).to receive(:read).and_return("var x = 10;")  
+  end
+
+  it "should merge a script change" do
+    util.configs = { "table_map" => {
+      "script_include" => {
+        "name" => "TestClass",
+        "table" => "sys_script_include", 
+        "sys_id" => "xxxxxx-sysid-xxxxxx",
+        "field" => "test-field"
+        }
+      }
+    } 
+    util.merge_update("script_include", "test_class.js")
+    expect(File).to have_received(:open).with("test_class.js")
+    expect(IO).to have_received(:read)
+    expect(FileUtils).to have_received(:cd).twice
+    expect(util.configs == { "table_map" => {
+      "script_include" => {
+        "name" => "TestClass", 
+        "table" => "sys_script_include", 
+        "sys_id" => "xxxxxx-sysid-xxxxxx", 
+        "field" => "test-field", 
+        "mod" => "var x = 10;"
+      }
+    }}).to be(true)
+end
+
+end
+
+describe "#start_sync" do
+
+  let :util do
+    SnowSync::SyncUtil.new(opts = "test")
+  end
+
+  before do
+    allow_any_instance_of(SnowSync::SyncUtil).to receive(:check_required_configs)
+    allow_any_instance_of(SnowSync::SyncUtil).to receive(:encrypt_credentials)
+    allow_any_instance_of(SnowSync::SyncUtil).to receive(:run_setup_and_sync)
+      .and_return("sync-and-setup-complete!")
+  end
+
+  it "should create a subdirectory" do
+    expect(util.start_sync).to eq("sync-and-setup-complete!")
+  end
+
+end
+
+describe "#push_modifications" do
+
+  let :util do
+    SnowSync::SyncUtil.new(opts = "test")
+  end
+
+  let :logger do
+    instance_double(Logger)
+  end
+
+  before do
+    allow_any_instance_of(SnowSync::SyncUtil).to receive(:table_lookup)
+      .and_return({
+        "name" => "TestClass",
+        "table" => "sys_script_include",
+        "sys_id" => "xxxxxx-sysid-xxxxxx",
+        "field" => "test-field",
+        "mod" => "var x = 10;"
+       })
+    allow_any_instance_of(SnowSync::SyncUtil).to receive(:merge_update)
+    allow(Base64).to receive(:strict_decode64).and_call_original
+    allow(Base64).to receive(:strict_encode64).and_call_original
+    allow(RestClient).to receive(:patch).and_return("{\"result\":[{ \"status\": \"201\" }]}")
+  end
+
+  it "should push modifications to the instance" do
+    util.configs = { "conf_path" => nil, 
+      "base_url" => "https://test.com/api/now/table/",
+      "creds" => {
+        "user" => "dGVzdC1uYW1l", 
+        "pass" => "dGVzdC1wYXNzd29yZA=="
+      },
+      "table_map" => {
+        "script_include" => {
+          "name" => "TestClass",
+          "table" => "sys_script_include", 
+          "sys_id" => "xxxxxx-sysid-xxxxxx",
+          "field" => "test-field",
+          "mod" => "var x = 10;"
+        }
+      }
+    }
+    util.push_modifications(["sync/script_include/test_class.js"]) 
+    expect(Base64).to have_received(:strict_decode64).with("dGVzdC1uYW1l")
+    expect(Base64).to have_received(:strict_decode64).with("dGVzdC1wYXNzd29yZA==")
+    expect(Base64).to have_received(:strict_encode64).with("test-name:test-password")
+    expect(RestClient).to have_received(:patch).with(
+      "https://test.com/api/now/table/sys_script_include/xxxxxx-sysid-xxxxxx",
+      "{\"test-field\":\"var x = 10;\"}",
+      {:authorization => "Basic " + "dGVzdC1uYW1lOnRlc3QtcGFzc3dvcmQ=", 
+       :content_type => "application/json", :accept => "application/json"})   
+  end
+
+  it "should handle an exception" do
+    allow(RestClient).to receive(:patch).and_raise(RestClient::ExceptionWithResponse)
+    allow(Logger).to receive(:new).and_return(logger)
+    allow(logger).to receive(:error)
+    util.configs = { "conf_path" => nil,
+      "base_url" => "https://test.com/api/now/table/",
+      "creds" => {
+        "user" => "dGVzdC1uYW1l",
+        "pass" => "dGVzdC1wYXNzd29yZA=="
+      },
+      "table_map" => {
+        "script_include" => {
+          "name" => "TestClass",
+          "table" => "sys_script_include",
+          "sys_id" => "xxxxxx-sysid-xxxxxx",
+          "field" => "test-field",
+          "mod" => "var x = 10;"
+        }
+      }
+    }
+    util.push_modifications(["sync/script_include/test_class.js"])
+    expect(logger).to have_received(:error)
+      .with("ERROR: RestClient::ExceptionWithResponse").once
+  end
+
+end
+
+describe "#notify" do
+
+  let :util do
+    SnowSync::SyncUtil.new(opts = "test")
+  end
+
+  let :logger do
+    instance_double(Logger)
+  end
+
+  let :update do
+    "test_class"
+  end
+
+  let :macosx? do
+    `uname`.chomp.downcase == "darwin"
+  end
+
+  let :linux? do
+    `uname`.chomp.downcase == "linux"
+  end
+
+  before do
+    allow(TerminalNotifier::Guard).to receive(:success) if macosx?
+    allow(Libnotify).to receive(:show) if linux?
+    allow(Logger).to receive(:new).and_return(logger)
+    allow(logger).to receive(:info)
+  end
+
+  condition = `uname`.chomp.downcase == "darwin"
+  context "when true", if: condition do
+    it "should send notification - macosx path" do
+      uname = "darwin"
+      util.notify(update, uname, util.logger)
+      expect(TerminalNotifier::Guard).to have_received(:success)
+        .with("File: #{update}", :title => "ServiceNow Script Update")
+      expect(logger).to have_received(:info).with("->: osx notification dispatched") 
+    end
+  end
+
+  condition = `uname`.chomp.downcase == "linux"
+  context "when true", if: condition do
+    it "should send notification - linux path" do
+      uname = "linux"
+      util.notify(update, uname, util.logger)
+      expect(Libnotify).to have_received(:show)
+        .with(:summary => "ServiceNow Script Update", :body => "File: #{update}")
+      expect(logger).to have_received(:info).with("->: linux notification dispatched") 
+    end
+  end
+
+end

data/spec/sync_util_spec.rb

@@ -1,9 +1,8 @@
 require "spec_helper"
 
-## --> unit tests
 describe "utility object" do
 
-  let! :util do
+  let :util do
     SnowSync::SyncUtil.new(opts = "test")
   end
 
@@ -21,22 +20,22 @@ describe "utility object" do
 
 end
 
-describe "create_directory" do
+describe "#create_directory" do
 
-  let! :util do
+  let :util do
     SnowSync::SyncUtil.new(opts = "test")
   end
 
-  let! :created_time do 
-    util.create_directory("sync")
-    return File.ctime("sync")
-  end
-
   it "should create a directory" do
+    util.create_directory("sync")
     dir = `ls`.split("\n")
     expect(dir.include?("sync")).to eq true
   end
 
+  let :created_time do
+    File.ctime("sync")
+  end
+
   it "should not create directory" do
     util.create_directory("sync")
     check_created_time = File.ctime("sync")
@@ -45,15 +44,22 @@ describe "create_directory" do
 
 end
 
-describe "create_file" do
+describe "#create_file" do
 
-  let! :util do
+  let :util do
     SnowSync::SyncUtil.new(opts = "test")
   end
 
-  it "should create a file" do
-    FileUtils.mkdir_p("sync")
+  before do 
     FileUtils.mkdir_p("sync/test_sub_dir")
+  end
+
+  after do
+    FileUtils.cd("../..")
+    FileUtils.rm_rf("sync")
+  end
+
+  it "should create a file" do
     json = { "property" => "value" }
     name = "TestClass".snakecase
     path = proc do
@@ -61,13 +67,11 @@ describe "create_file" do
     end
     util.create_file(name, json, &path)
     expect(File.exists?("test_class.js")).to eq true
-    FileUtils.cd("../..")
-    FileUtils.rm_rf("sync")
   end
 
 end
 
-describe "check_required_configs" do
+describe "#check_required_configs" do
 
   let :util do
     SnowSync::SyncUtil.new(opts = "test")
@@ -75,35 +79,40 @@ describe "check_required_configs" do
 
   it "should raise an exception when there is no config path" do
     util.configs["conf_path"] = nil
-    expect{util.check_required_configs}.to raise_error(/Check the configuration path, base url, credentials or table to sync/)
+    expect{util.check_required_configs}.to raise_error(
+      /Check the configuration path, base url, credentials or table to sync/)
   end
 
   it "should raise an exception when there is no base url" do
     util.configs["base_url"] = nil
-    expect{util.check_required_configs}.to raise_error(/Check the configuration path, base url, credentials or table to sync/)
+    expect{util.check_required_configs}.to raise_error(
+      /Check the configuration path, base url, credentials or table to sync/)
   end
 
   it "should raise an exception when there is no username" do
     util.configs["creds"]["user"] = nil
-    expect{util.check_required_configs}.to raise_error(/Check the configuration path, base url, credentials or table to sync/)
+    expect{util.check_required_configs}.to raise_error(
+      /Check the configuration path, base url, credentials or table to sync/)
   end
 
   it "should raise an exception when there is no password" do
     util.configs["creds"]["pass"] = nil
-    expect{util.check_required_configs}.to raise_error(/Check the configuration path, base url, credentials or table to sync/)
+    expect{util.check_required_configs}.to raise_error(
+      /Check the configuration path, base url, credentials or table to sync/)
   end
 
   it "should raise an exception when there are no tables mapped" do
     tables = util.configs["table_map"].keys
     tables.each do |table|
       util.configs["table_map"][table]["table"] = nil
-      expect{util.check_required_configs}.to raise_error(/Check the configuration path, base url, credentials or table to sync/)
+      expect{util.check_required_configs}.to raise_error(
+        /Check the configuration path, base url, credentials or table to sync/)
     end
   end
 
 end
 
-describe "classify" do
+describe "#classify" do
 
   let :util do
     SnowSync::SyncUtil.new(opts = "test")
@@ -118,7 +127,7 @@ describe "classify" do
 
 end
 
-describe "table_lookup" do
+describe "#table_lookup" do
 
   let :util do
     SnowSync::SyncUtil.new(opts = "test")
@@ -132,15 +141,21 @@ describe "table_lookup" do
 
 end
 
-describe "merge_update" do
+describe "#merge_update" do
 
-  let! :util do
+  let :util do
     SnowSync::SyncUtil.new(opts = "test")
   end
 
+  before do
+    FileUtils.mkdir_p("sync/script_include") 
+  end
+
+  after do
+    FileUtils.rm_rf("sync")
+  end
+
   it "should merge script with the configs object" do
-    FileUtils.mkdir_p("sync")
-    FileUtils.mkdir_p("sync/script_include")
     json_resp = "var test = 'test'; \n" +
     "var testing = function(arg) { \n\tgs.print(arg) \n}; \n" +
     "testing('test');"
@@ -154,26 +169,30 @@ describe "merge_update" do
     path = file.split("/")
     type = path[1]
     file = path[2]
-    table_map = util.table_lookup(type, file)
-    util.merge_update(type, file, table_map)
+    util.merge_update(type, file)
     expect(util.configs["table_map"]["script_include"]["mod"] != nil).to eq true
-    FileUtils.rm_rf("sync")
   end
 
 end
 
-## --> integration tests
-describe "setup_sync_directories" do
+describe "#run_setup_and_sync" do
  
-  let! :util do
+  let :util do
     SnowSync::SyncUtil.new(opts = "test")
   end
 
-  it "should setup and synchronize field from the SN instance" do
+  before do
+    util.encrypt_credentials
+  end
+
+  after do
+    FileUtils.rm_rf("sync")
+  end
+
+  it "should setup file locally and sync code from the instance" do
     util.run_setup_and_sync
     file = File.open("sync/script_include/test_class.js")
     expect(file.is_a?(Object)).to eq true
-    FileUtils.rm_rf("sync")
   end
  
 end
@@ -184,23 +203,32 @@ describe "push_modifications - single table configuration" do
     SnowSync::SyncUtil.new(opts = "test")
   end
 
+  before do
+    util.encrypt_credentials
+  end
+ 
+  after do
+    FileUtils.rm_rf("sync")
+  end
+
   it "should push modifications to a configured instance" do
     util.run_setup_and_sync
     file = File.open("sync/script_include/test_class.js", "r+")
     lines = file.readlines
     file.close
-    lines[0] = "// test comment -\n"
+    lines[0] = "// test comment - single push \n"
     newfile = File.new("sync/script_include/test_class.js", "w")
     lines.each do |line|
       newfile.write(line)
     end
     newfile.close
     util.push_modifications(["sync/script_include/test_class.js"])
+    # resync confirms mods were pushed to the instance
     util.run_setup_and_sync
     file = File.open("sync/script_include/test_class.js", "r+")
     lines = file.readlines
     file.close
-    expect(lines[0]).to eq "// test comment -\n"
+    expect(lines[0]).to eq "// test comment - single push \n"
   end
 
 end
@@ -211,7 +239,15 @@ describe "push_modifications - mutli-table configuration" do
     SnowSync::SyncUtil.new(opts = "test")
   end
 
-  it "should sync, update, queue, push, re-sync mods for a configured instance" do
+  before do
+    util.encrypt_credentials
+  end
+       
+  after do
+    FileUtils.rm_rf("sync")
+  end
+
+  it "should push modifications to a configured instance" do
     def do_edit(file, edit)
       file = File.open(file, "r+")
       lines = file.readlines
@@ -231,14 +267,18 @@ describe "push_modifications - mutli-table configuration" do
     end
     util.run_setup_and_sync
     # sys_script_include
-    do_edit("sync/script_include/test_class.js", "// test comment -\n")
+    do_edit(
+      "sync/script_include/test_class.js", "// test comment - multi push 1\n")
     # sys_ui_action
-    do_edit("sync/ui_action/test.js", "// test comment -\n")
+    do_edit(
+      "sync/ui_action/test_action.js", "// test comment - multi push 2\n")
     # queued mods, push in sequence
-    util.push_modifications(["sync/script_include/test_class.js", "sync/ui_action/test.js"])
+    util.push_modifications(
+      ["sync/script_include/test_class.js", "sync/ui_action/test_action.js"])
+    # resync confirms mods were pushed to the instance
     util.run_setup_and_sync
-    run_check("sync/script_include/test_class.js", "// test comment -\n")
-    run_check("sync/ui_action/test.js", "// test comment -\n")
+    run_check("sync/script_include/test_class.js", "// test comment - multi push 1\n")
+    run_check("sync/ui_action/test_action.js", "// test comment - multi push 2\n")
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snow_sync
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.6
 platform: ruby
 authors:
 - Andy Wallace
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-03 00:00:00.000000000 Z
+date: 2022-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.3.3
 - !ruby/object:Gem::Dependency
   name: facets
   requirement: !ruby/object:Gem::Requirement
@@ -72,20 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: 2.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: 2.6.1
 - !ruby/object:Gem::Dependency
   name: libnotify
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.0
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.0
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -134,14 +128,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.10.1
 - !ruby/object:Gem::Dependency
   name: terminal-notifier-guard
   requirement: !ruby/object:Gem::Requirement
@@ -187,7 +195,9 @@ files:
 - lib/snow_sync/configs.yml
 - lib/snow_sync/sync_util.rb
 - lib/snow_sync/version.rb
+- spec/docker_install_spec.rb
 - spec/spec_helper.rb
+- spec/sync_util_mock_spec.rb
 - spec/sync_util_spec.rb
 homepage: https://rubygems.org/gems/snow_sync
 licenses:
@@ -208,8 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: SnowSync is a file sync utility tool and API which provides a bridge for