bitcoin_cleaner 1.0.0.beta.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13e0b9e2b053325e5440e4fe6bdc3ef0b014e3fa
+  data.tar.gz: 361f83cda81da4476da8db34163c0dd57c51f7c2
+SHA512:
+  metadata.gz: 0956d30f1d26251d94d5d66bd82831f278edbda6e4d4ef8baf59a183bb5a10d4a59aa84bc1dd0168896761aa4e978c7281488153c5e16fb69126b752f5fa8121
+  data.tar.gz: ce78594ba00148cab2b2137418d88b76d6c62c359086178fb265a728bf1ea941d084604377df002f532dd9de85b8101ff56dd73be74f2630274af5009d7afd8e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.gitmodules

@@ -0,0 +1,9 @@
+[submodule "git:/github.com/freewil/bitcoin-testnet-box.git"]
+	path = git:/github.com/freewil/bitcoin-testnet-box.git
+	url = ./testnet
+[submodule "git@github.com:freewil/bitcoin-testnet-box.git"]
+	path = git@github.com:freewil/bitcoin-testnet-box.git
+	url = ./testnet
+[submodule "testnet"]
+	path = testnet
+	url = git://github.com/freewil/bitcoin-testnet-box.git

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# 1.0.0.beta.1
+
+- Rename project from BitcoinTestnet to BitcoinCleaner
+- Use `-regtest` switch on bitcoind instead of the testnet
+
+# v0.6.0
+
+- remove embedded testnet
+
+# v0.5.1
+
+- Do not record the vcr cassette if the example fails [#6]
+
+# v0.5.0
+
+- Redirect all bitcoin make logging to /dev/null -- makes things more quiet when running specs
+
+# v0.4.1
+
+- Loosen constraint on ActiveSupport version

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bitcoin_cleaner.gemspec
+gemspec
+
+gem "pry", "0.9.12.2"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 - 2014 Ramon Tayag
+
+MIT License
+
+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,44 @@
+# BitcoinCleaner
+
+Makes development with Bitcoin a little easier. It has helpers that can be used to start, stop, clean the bitcoin daemon. The bitcoin daemon will be run in regtest mode.
+
+This gem been written using Bitcoin Core `0.9.2.1`. BitcoinCleaner takes advantage of the `regtest` option in the new version of Bitcoin Core. Starting `bitcoind -regtest` will create a private network that's a lot faster than the testnet, and easier to manage then a private testnet.
+
+## Usage
+
+1. Make sure that Bitcoin Core is installed in your system and `bitcoind` and `bitcoin-cli` are in your path.
+2. Require the library in your `test_helper`/`spec_helper`: `require 'bitcoin_cleaner'`. Now, you have access to `BitcoinCleaner`.
+3. In your `test_helper`/`spec_helper` add `BitcoinCleaner.conf_dir = "/path/to/conf/dir"`. This is the folder that contains the bitcoin.conf, and more importantly, the `regtest`. The wallet in `regtest/wallet.dat` will be deleted between runs to make the wallet pristine again. It normally looks like this:
+
+```
+~ ❯❯❯ ls ~/.bitcoin
+blocks  chainstate  regtest  bitcoin.conf  db.log  debug.log  peers.dat  wallet.dat
+```
+
+4. Tell `BitcoinCleaner` when to do its work by adding `bitcoin_cleaner: true` to the metadata.
+
+Sample with RSpec:
+
+```
+it "sends bitcoin to the given address", bitcoin_cleaner: true
+```
+
+### RSpec and VCR
+
+Cleaning the daemon every time is slow. If you have VCR, you can make this a lot faster by calling `BitcoinCleaner.configure_with_rspec_and_vcr!` in your spec helper. With this, you won't need to call `BitcoinCleaner#start` and `BitcoinCleaner#stop`.
+
+## Tip
+
+To make integration tests faster, use something like [VCR](https://github.com/vcr/vcr) to record the communication between your project and the daemon.
+
+## Contributing
+
+I suggest you do your development in this [Vagrant box](https://github.com/ramontayag/ruby-bitcoin-box). I use it for my development.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+If you find this useful, consider sharing some BTC love: `1PwQWijmJ39hWXk9X3CdAhEdExdkANEAPk`

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bitcoin_cleaner.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bitcoin_cleaner/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "bitcoin_cleaner"
+  gem.version       = BitcoinCleaner::VERSION
+  gem.authors       = ["Ramon Tayag"]
+  gem.email         = ["ramon.tayag@gmail.com"]
+  gem.description   = %q{A gem of helpers for making integration tests with the Bitcoind a little easier.}
+  gem.summary       = %q{A gem of helpers for making integration tests with the Bitcoind a little easier.}
+  gem.homepage      = "https://github.com/ramontayag/ruby-bitcoin_cleaner"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'wait', '~> 0.5.1'
+  gem.add_development_dependency 'rspec', "~> 3.0"
+  gem.add_development_dependency 'vcr'
+end

data/lib/bitcoin_cleaner.rb

@@ -0,0 +1,44 @@
+require 'wait'
+require "bitcoin_cleaner/version"
+require 'active_support/core_ext'
+
+require 'bitcoin_cleaner/detector'
+require 'bitcoin_cleaner/executor'
+require 'bitcoin_cleaner/booter'
+require 'bitcoin_cleaner/stopper'
+require 'bitcoin_cleaner/executes'
+require 'bitcoin_cleaner/prepares_command'
+require 'bitcoin_cleaner/vcr_integrator'
+require 'bitcoin_cleaner/check_vcr_cassette'
+require 'bitcoin_cleaner/determine_run'
+
+module BitcoinCleaner
+
+  mattr_accessor :dir
+  @@dir = nil
+
+  mattr_accessor :current_test
+  @@current_test = nil
+
+  def self.start
+    Booter.boot
+  end
+
+  def self.stop
+    Stopper.stop
+  end
+
+  def self.configure_with_rspec_and_vcr!
+    RSpec.configure do |c|
+      c.before(:each) { VcrIntegrator.start(example) }
+      c.after(:each) { VcrIntegrator.stop(example) }
+    end
+
+    VCR.configure do |c|
+      c.before_record do |interaction|
+        interaction.ignore! if BitcoinCleaner.current_test.exception
+      end
+    end
+  end
+
+end

data/lib/bitcoin_cleaner/booter.rb

@@ -0,0 +1,36 @@
+module BitcoinCleaner
+  class Booter
+
+    def self.boot(*args)
+      Stopper.stop if Detector.exists?
+
+      pid_file = File.join(BitcoinCleaner.dir, "regtest", "bitcoind.pid")
+      thread = Thread.new do
+        Executes.command "bitcoind -regtest -daemon -pid=#{pid_file}"
+      end
+
+      Wait.new.until do
+        thread.status == false && Detector.exists?
+      end
+
+      if Detector.exists?
+        generate_coins
+      else
+        message = [
+          "The bitcoin processes didn't seem to start",
+          "Please ensure that the bitcoind can be started",
+        ]
+        fail message*". "
+      end
+    end
+
+    def self.generate_coins
+      Executes.command "bitcoin-cli -regtest setgenerate true 101"
+      Wait.new.until do
+        default_account_balance = `bitcoin-cli -regtest getbalance ""`.to_f
+        default_account_balance > 0
+      end
+    end
+
+  end
+end

data/lib/bitcoin_cleaner/check_vcr_cassette.rb

@@ -0,0 +1,9 @@
+module BitcoinCleaner
+  class CheckVcrCassette
+
+    def self.exists?(cassette)
+      !!(cassette && cassette.file && File.exists?(cassette.file))
+    end
+
+  end
+end

data/lib/bitcoin_cleaner/detector.rb

@@ -0,0 +1,15 @@
+module BitcoinCleaner
+  class Detector
+
+    def self.exists?
+      processes.size >= 1
+    end
+
+    private
+
+    def self.processes
+      `ps -ef | grep "bitcoind -regtest" | grep -v grep`.split("\n")
+    end
+
+  end
+end

data/lib/bitcoin_cleaner/determine_run.rb

@@ -0,0 +1,23 @@
+module BitcoinCleaner
+  class DetermineRun
+
+    def self.execute(rspec_example)
+      return true unless defined?(VCR)
+
+      bitcoin_cleaner_metadata = rspec_example.metadata[:bitcoin_cleaner]
+      vcr_metadata = rspec_example.metadata[:vcr]
+      return false unless bitcoin_cleaner_metadata == true
+      if vcr_metadata != true && !vcr_metadata.nil?
+        return false if vcr_metadata[:record] == :once && cassette_exists?
+      end
+      true
+    end
+
+    private
+
+    def self.cassette_exists?
+      CheckVcrCassette.exists?(VCR.current_cassette)
+    end
+
+  end
+end

data/lib/bitcoin_cleaner/executes.rb

@@ -0,0 +1,10 @@
+module BitcoinCleaner
+  class Executes
+
+    def self.command(c)
+      prepared_command = PreparesCommand.for_silence(c)
+      system prepared_command
+    end
+
+  end
+end

data/lib/bitcoin_cleaner/executor.rb

@@ -0,0 +1,20 @@
+module BitcoinCleaner
+  class Executor
+
+    def self.execute(*args)
+      self.new(*args).execute
+    end
+
+    def initialize(*commands)
+      @commands = commands
+    end
+
+    def execute
+      Dir.chdir BitcoinCleaner.dir do
+        commands = @commands.map { |c| "#{c} > /dev/null 2>&1"}
+        system commands.join(' && ')
+      end
+    end
+
+  end
+end

data/lib/bitcoin_cleaner/prepares_command.rb

@@ -0,0 +1,9 @@
+module BitcoinCleaner
+  class PreparesCommand
+
+    def self.for_silence(command)
+      "#{command} > /dev/null 2>&1"
+    end
+
+  end
+end

data/lib/bitcoin_cleaner/stopper.rb

@@ -0,0 +1,23 @@
+module BitcoinCleaner
+  class Stopper
+
+    def self.stop
+      kill_bitcoind if Detector.exists?
+      Wait.new.until { !Detector.exists? }
+      fail "Looks like it didn't stop" if Detector.exists?
+      remove_regtest_dir
+    end
+
+    private
+
+    def self.kill_bitcoind
+      system %Q(kill -9 `ps -ef | grep "bitcoind -regtest" | grep -v grep | awk '{print $2}'`)
+    end
+
+    def self.remove_regtest_dir
+      regtest_dir = File.join(BitcoinCleaner.dir, "regtest")
+      FileUtils.rm_rf regtest_dir
+    end
+
+  end
+end

data/lib/bitcoin_cleaner/vcr_integrator.rb

@@ -0,0 +1,31 @@
+module BitcoinCleaner
+  class VcrIntegrator
+
+    def self.start(*args)
+      self.new(*args).start
+    end
+
+    def self.stop(*args)
+      self.new(*args).stop
+    end
+
+    def initialize(rspec_example)
+      BitcoinCleaner.current_test = @rspec_example = rspec_example
+    end
+
+    def start
+      BitcoinCleaner.start if should_perform?
+    end
+
+    def stop
+      BitcoinCleaner.stop if should_perform?
+    end
+
+    private
+
+    def should_perform?
+      DetermineRun.execute(@rspec_example)
+    end
+
+  end
+end

data/lib/bitcoin_cleaner/version.rb

@@ -0,0 +1,3 @@
+module BitcoinCleaner
+  VERSION = "1.0.0.beta.1"
+end

data/spec/bitcoin_testnet/check_vcr_cassette_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+module BitcoinCleaner
+  describe CheckVcrCassette, ".exists?" do
+
+    subject { described_class.exists?(current_cassette) }
+
+    context "there is a cassette" do
+      let(:current_cassette) { double(file: file_path) }
+      let(:file_path) { File.join(SPEC_DIR, "..", "tmp", "cassette.xml") }
+
+      context "there is a file" do
+        context "file exists in the disk" do
+          before { FileUtils.touch(file_path) }
+          it { is_expected.to be true }
+        end
+
+        context "file does not exist on the disk" do
+          before { FileUtils.rm(file_path) }
+          it { is_expected.to be false }
+        end
+      end
+
+      context "there is no file" do
+        let(:cassette_file) { nil }
+        it { is_expected.to be false }
+      end
+    end
+
+    context "there is no cassette" do
+      let(:current_cassette) { nil }
+      it { is_expected.to be false }
+    end
+
+  end
+end

data/spec/bitcoin_testnet/determine_run_spec.rb

@@ -0,0 +1,101 @@
+require "spec_helper"
+
+module BitcoinCleaner
+  describe DetermineRun, ".execute" do
+
+    let(:rspec_example) do
+      double(
+        metadata: {
+          vcr: vcr_metadata,
+          bitcoin_cleaner: bitcoin_cleaner_metadata,
+        }
+      )
+    end
+
+    let(:current_cassette) { double }
+    let(:vcr_metadata) { nil }
+
+    subject { described_class.execute(rspec_example) }
+
+    before do
+      allow(VCR).to receive(:current_cassette).and_return(current_cassette)
+    end
+
+    context "bitcoin_cleaner is false" do
+      let(:bitcoin_cleaner_metadata) { false }
+
+      it { is_expected.to be false }
+    end
+
+    context "bitcoin_cleaner is true" do
+      let(:bitcoin_cleaner_metadata) { true }
+      context "vcr metadata is true and cassette exists" do
+        let(:vcr_metadata) { true }
+
+        before do
+          allow(CheckVcrCassette).to receive(:exists?).with(current_cassette).
+            and_return(true)
+        end
+
+        it { is_expected.to be true }
+      end
+
+      context "vcr metadata is true and cassette does not exist" do
+        let(:vcr_metadata) { true }
+
+        before do
+          allow(CheckVcrCassette).to receive(:exists?).with(current_cassette).
+            and_return(false)
+        end
+
+        it { is_expected.to be true }
+      end
+
+      context "vcr metadata is set to record all and cassette exists" do
+        let(:vcr_metadata) { {record: :all} }
+        before do
+          allow(CheckVcrCassette).to receive(:exists?).with(current_cassette).
+            and_return(true)
+        end
+
+        it { is_expected.to be true }
+      end
+
+      context "vcr metadata is set to record all and cassette does not exist" do
+        let(:vcr_metadata) { {record: :all} }
+        before do
+          allow(CheckVcrCassette).to receive(:exists?).with(current_cassette).
+            and_return(false)
+        end
+
+        it { is_expected.to be true }
+      end
+
+      context "vcr metadata is set to record once and cassette exists" do
+        let(:vcr_metadata) { {record: :once} }
+        before do
+          allow(CheckVcrCassette).to receive(:exists?).with(current_cassette).
+            and_return(true)
+        end
+
+        it { is_expected.to be false }
+      end
+
+      context "vcr metadata is set to record once and cassette does not exist" do
+        let(:vcr_metadata) { {record: :once} }
+        before do
+          allow(CheckVcrCassette).to receive(:exists?).with(current_cassette).
+            and_return(false)
+        end
+
+        it { is_expected.to be true }
+      end
+
+      context "vcr metadata is not set" do
+        let(:vcr_metadata) { nil }
+        it { is_expected.to be true }
+      end
+    end
+
+  end
+end

data/spec/bitcoin_testnet/executes_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+module BitcoinCleaner
+  describe Executes do
+
+    describe ".command" do
+      it "executes the prepared command" do
+        command = "do this"
+        prepared_command = "do this prepared"
+
+        allow(PreparesCommand).to receive(:for_silence).with(command).
+          and_return(prepared_command)
+
+        expect(described_class).to receive(:system).with(prepared_command)
+
+        described_class.command(command)
+      end
+    end
+
+  end
+end

data/spec/bitcoin_testnet/executor_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+module BitcoinCleaner
+  describe Executor, ".execute" do
+
+    it "executes the given commands piping stderr and sdout each to /dev/null" do
+      commands = [
+        "command 1",
+        "comm2"
+      ]
+
+    end
+
+  end
+end

data/spec/bitcoin_testnet/prepares_command_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+module BitcoinCleaner
+  describe PreparesCommand do
+
+    describe ".for_silence" do
+      it "redirects stdout and stderr to /dev/null" do
+        expect(described_class.for_silence("some command")).
+          to eq("some command > /dev/null 2>&1")
+      end
+    end
+
+  end
+end

data/spec/bitcoin_testnet/vcr_integrator_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+module BitcoinCleaner
+  describe VcrIntegrator do
+
+    describe ".start" do
+      it "sets the BitcoinCleaner.current_test to be the given test" do
+        test = double(metadata: {})
+        described_class.start(test)
+        expect(BitcoinCleaner.current_test).to eq(test)
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "bundler/setup"
+Bundler.require(:default, :development)
+
+SPEC_DIR = File.dirname(__FILE__)
+TMP_DIR = File.join(SPEC_DIR, "..", "tmp")
+FileUtils.mkdir_p(TMP_DIR)

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: bitcoin_cleaner
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta.1
+platform: ruby
+authors:
+- Ramon Tayag
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wait
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem of helpers for making integration tests with the Bitcoind a little
+  easier.
+email:
+- ramon.tayag@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .gitmodules
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bitcoin_cleaner.gemspec
+- lib/bitcoin_cleaner.rb
+- lib/bitcoin_cleaner/booter.rb
+- lib/bitcoin_cleaner/check_vcr_cassette.rb
+- lib/bitcoin_cleaner/detector.rb
+- lib/bitcoin_cleaner/determine_run.rb
+- lib/bitcoin_cleaner/executes.rb
+- lib/bitcoin_cleaner/executor.rb
+- lib/bitcoin_cleaner/prepares_command.rb
+- lib/bitcoin_cleaner/stopper.rb
+- lib/bitcoin_cleaner/vcr_integrator.rb
+- lib/bitcoin_cleaner/version.rb
+- spec/bitcoin_testnet/check_vcr_cassette_spec.rb
+- spec/bitcoin_testnet/determine_run_spec.rb
+- spec/bitcoin_testnet/executes_spec.rb
+- spec/bitcoin_testnet/executor_spec.rb
+- spec/bitcoin_testnet/prepares_command_spec.rb
+- spec/bitcoin_testnet/vcr_integrator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ramontayag/ruby-bitcoin_cleaner
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A gem of helpers for making integration tests with the Bitcoind a little
+  easier.
+test_files:
+- spec/bitcoin_testnet/check_vcr_cassette_spec.rb
+- spec/bitcoin_testnet/determine_run_spec.rb
+- spec/bitcoin_testnet/executes_spec.rb
+- spec/bitcoin_testnet/executor_spec.rb
+- spec/bitcoin_testnet/prepares_command_spec.rb
+- spec/bitcoin_testnet/vcr_integrator_spec.rb
+- spec/spec_helper.rb