WIP: Refactor cookbook

Author: infertux

.github/workflows/test.yml

@@ -0,0 +1,40 @@
+name: Test
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  kitchen:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ "default-debian-11", "default-debian-12", "default-ubuntu-2204", "default-ubuntu-2404" ]
+        recipe: [ "binary", "source" ]
+        variant: [ "core" ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby  # latest stable release
+          bundler-cache: true  # runs 'bundle install' and caches installed gems automatically
+      - name: Run Test Kitchen platform ${{ matrix.platform }}
+        run: env KITCHEN_RECIPE=${{ matrix.recipe }} KITCHEN_VARIANT=${{ matrix.variant }} bundle exec rake kitchen:${{ matrix.platform }}
+  style:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby  # latest stable release
+          bundler-cache: true  # runs 'bundle install' and caches installed gems automatically
+      - name: Run style checks
+        run: bundle exec rake style:ruby

.kitchen.yml

@@ -1,21 +1,59 @@
 ---
 driver:
-  name: docker
+  name: dokken
+  privileged: true # allows systemd services to start
+  chef_image: cincproject/cinc
+  chef_version: <%= ENV.fetch('CHEF_VERSION', 18) %>
 
 provisioner:
-  name: chef_zero
-  product_name: chef
-  product_version: <%= ENV["CHEF_VERSION"] || '14' %>
+  name: dokken
+  product_name: cinc
+  chef_binary: /opt/cinc/bin/cinc-client
+  deprecations_as_errors: true
+  multiple_converge: 2
+
+transport:
+  name: dokken
+
+verifier:
+  name: inspec
 
 platforms:
-  - name: <%= ENV["KITCHEN_PLATFORM"] %>
-    driver_config:
-      use_sudo: false
+  # @see https://github.com/chef-cookbooks/testing_examples/blob/main/kitchen.dokken.yml
+  # @see https://hub.docker.com/u/dokken
+  - name: debian-11
+    driver:
+      image: dokken/debian-11
+      pid_one_command: /bin/systemd
+      intermediate_instructions:
+        - RUN /usr/bin/apt-get update
+        - RUN /usr/bin/apt-get upgrade -y
+  - name: debian-12
+    driver:
+      image: dokken/debian-12
+      pid_one_command: /bin/systemd
+      intermediate_instructions:
+        - RUN /usr/bin/apt-get update
+        - RUN /usr/bin/apt-get upgrade -y
+  - name: ubuntu-2204
+    driver:
+      image: dokken/ubuntu-22.04
+      pid_one_command: /bin/systemd
+      intermediate_instructions:
+        - RUN /usr/bin/apt-get update
+        - RUN /usr/bin/apt-get upgrade -y
+  - name: ubuntu-2404
+    driver:
+      image: dokken/ubuntu-24.04
+      pid_one_command: /bin/systemd
+      intermediate_instructions:
+        - RUN /usr/bin/apt-get update
+        - RUN /usr/bin/apt-get upgrade -y
 
 suites:
   - name: default
     run_list:
-      - recipe[bitcoin::<%= ENV["KITCHEN_RECIPE"] %>]
+      - recipe[bitcoin::<%= ENV.fetch('KITCHEN_RECIPE', 'binary') %>]
     attributes:
       bitcoin:
-        variant: <%= ENV["KITCHEN_VARIANT"] %>
+        variant: <%= ENV.fetch('KITCHEN_VARIANT', 'core') %>

.travis.yml

@@ -1,17 +1,11 @@
 source 'https://rubygems.org'
 
-group :development do
-  gem 'berkshelf'
-  gem 'chef', '~> 14'
-  gem 'rake'
-end
-
-group :style do
-  gem 'cookstyle'
-  gem 'foodcritic'
-end
+gem 'rake'
 
 group :test do
-  gem 'kitchen-docker'
+  gem 'berkshelf' # needed by test-kitchen
+  gem 'cookstyle'
+  gem 'kitchen-dokken'
+  gem 'kitchen-inspec'
   gem 'test-kitchen'
 end

Gemfile

@@ -1,3 +1,5 @@
+require 'thor' # XXX: load thor explicitly to prevent "Kitchen::ClientError: Could not load the 'inspec' verifier. Error: undefined method `parse_array' for class `Thor::Arguments'"
+
 namespace :style do
   desc 'Run Ruby style checks'
   require 'cookstyle'
@@ -8,21 +10,12 @@ namespace :style do
     task.options << '--extra-details'
     task.options << '--display-style-guide'
   end
-
-  desc 'Run Chef style checks'
-  require 'foodcritic'
-  FoodCritic::Rake::LintTask.new(:chef) do |task|
-    task.options[:fail_tags] = ['any']
-  end
 end
 
 desc 'Run all style checks'
-task 'style:all' => ['style:ruby', 'style:chef']
+task 'style:all' => ['style:ruby']
 
-if ENV['KITCHEN_PLATFORM']
-  require 'kitchen/rake_tasks'
-  Kitchen::RakeTasks.new
-  task default: ['style:all', 'kitchen:all']
-else
-  task default: ['style:all']
-end
+require 'kitchen/rake_tasks'
+Kitchen::RakeTasks.new
+
+task default: %w(kitchen:all style:all)

Gemfile.lock

@@ -5,7 +5,7 @@
 
 # common settings
 
-default['bitcoin']['variant'] = nil # possible variants: abc, bucash, core, unlimited, xt
+default['bitcoin']['variant'] = 'core' # possible variants: core
 
 default['bitcoin']['binary_name'] = 'bitcoind'
 default['bitcoin']['binary_cli_name'] = 'bitcoin-cli'
@@ -24,18 +24,9 @@
 
 # 'binary' recipe
 
-default['bitcoin']['binary']['version']['core']       = '0.18.1'
-default['bitcoin']['binary']['version']['unlimited']  = '1.0.3.0'
-default['bitcoin']['binary']['version']['bucash']     = '1.6.0.1'
-default['bitcoin']['binary']['version']['abc']        = '0.20.0'
-default['bitcoin']['binary']['url']['core']           = "https://bitcoin.org/bin/bitcoin-core-#{node['bitcoin']['binary']['version']['core']}/bitcoin-#{node['bitcoin']['binary']['version']['core']}-x86_64-linux-gnu.tar.gz"
-default['bitcoin']['binary']['url']['unlimited']      = "https://www.bitcoinunlimited.info/downloads/bitcoinUnlimited-#{node['bitcoin']['binary']['version']['unlimited']}-linux64.tar.gz"
-default['bitcoin']['binary']['url']['bucash']         = "https://www.bitcoinunlimited.info/downloads/BUcash-#{node['bitcoin']['binary']['version']['bucash']}-linux64.tar.gz"
-default['bitcoin']['binary']['url']['abc']            = "https://download.bitcoinabc.org/#{node['bitcoin']['binary']['version']['abc']}/linux/bitcoin-abc-#{node['bitcoin']['binary']['version']['abc']}-x86_64-linux-gnu.tar.gz"
-default['bitcoin']['binary']['checksum']['core']      = '600d1db5e751fa85903e935a01a74f5cc57e1e7473c15fd3e17ed21e202cfe5a'
-default['bitcoin']['binary']['checksum']['unlimited'] = 'a6658bac22f082539969a243943c7d1a865abd40cdfe39465ff82b4eba387b22'
-default['bitcoin']['binary']['checksum']['bucash']    = '68023e6faefe7cfee8eee6cffb6200f52d47aa89c305323d97063664b514c94c'
-default['bitcoin']['binary']['checksum']['abc']       = 'c00afe0f23163a64b692f9633ab0f49af7eedde32aa7b768582a0a731bb6d013'
+default['bitcoin']['binary']['version']['core']       = '27.0'
+default['bitcoin']['binary']['url']['core']           = "https://bitcoincore.org/bin/bitcoin-core-#{node['bitcoin']['binary']['version']['core']}/bitcoin-#{node['bitcoin']['binary']['version']['core']}-x86_64-linux-gnu.tar.gz"
+default['bitcoin']['binary']['checksum']['core']      = '2a6974c5486f528793c79d42694b5987401e4a43c97f62b1383abf35bcee44a8'
 
 # 'package' recipe
 
@@ -46,18 +37,9 @@
 
 # 'source' recipe
 
-default['bitcoin']['source']['version']['core']       = 'v0.18.1'
-default['bitcoin']['source']['version']['unlimited']  = '1.0.1.3'
-default['bitcoin']['source']['version']['bucash']     = '1.6.0.1'
-default['bitcoin']['source']['version']['abc']        = '0.20.0'
+default['bitcoin']['source']['version']['core']       = '27.0'
 default['bitcoin']['source']['url']['core']           = "https://github.com/bitcoin/bitcoin/archive/#{node['bitcoin']['source']['version']['core']}.tar.gz"
-default['bitcoin']['source']['url']['unlimited']      = "https://github.com/BitcoinUnlimited/BitcoinUnlimited/archive/#{node['bitcoin']['source']['version']['unlimited']}.tar.gz"
-default['bitcoin']['source']['url']['bucash']         = "https://github.com/BitcoinUnlimited/BitcoinUnlimited/archive/bucash#{node['bitcoin']['source']['version']['bucash']}.tar.gz"
-default['bitcoin']['source']['url']['abc']            = "https://github.com/Bitcoin-ABC/bitcoin-abc/archive/v#{node['bitcoin']['source']['version']['abc']}.tar.gz"
-default['bitcoin']['source']['checksum']['core']      = '5c7d93f15579e37aa2d1dc79e8f5ac675f59045fceddf604ae0f1550eb03bf96'
-default['bitcoin']['source']['checksum']['unlimited'] = '50e9f948ef27d583cd411bf0925da40ee55a515ce3c7745404f6aa1de6503c06'
-default['bitcoin']['source']['checksum']['bucash']    = '329f2bbe508d3dddb62fda284f33b42e346ef9ba1e1eb09924d592c98d7adc23'
-default['bitcoin']['source']['checksum']['abc']       = '5a26a8ae8c1cdb4769e4277335733782a6b9bce97af54e1bffeac489c68f3975'
+default['bitcoin']['source']['checksum']['core']      = '9c1ee651d3b157baccc3388be28b8cf3bfcefcd2493b943725ad6040ca6b146b'
 default['bitcoin']['source']['dependencies']['debian'] = %w(
   build-essential libtool autoconf pkg-config libssl-dev libevent-dev
   libboost-system-dev libboost-filesystem-dev libboost-chrono-dev

Rakefile

@@ -6,10 +6,9 @@
 source_url       'https://github.com/infertux/chef-bitcoin'
 issues_url       'https://github.com/infertux/chef-bitcoin/issues'
 
-version          '1.8.0'
-chef_version     '>= 13.3'
+version          '2.0.0'
+chef_version     '>= 18'
 
-supports 'debian'
-supports 'ubuntu'
-supports 'centos'
+supports 'debian', '>= 11.0'
 supports 'freebsd'
+supports 'ubuntu', '>= 22.04'

attributes/default.rb

@@ -2,12 +2,8 @@ server=1
 checkblocks=<%= node['bitcoin']['checkblocks'] %>
 rpcbind=127.0.0.1
 rpcallowip=127.0.0.1
-txindex=1 # needed for ElectrumX server
+txindex=1 # needed for ElectrumX/Fulcrum server
 par=-1
-<% if %w(abc core xt).include?(node['bitcoin']['variant']) %>
-sendfreetransactions=1
-mempoolreplacement=0 # no RBF
-<% end %>
 dbcache=500 # set if you have 4+ GiB RAM
 #maxconnections=50 # set to limit bandwidth usage
 #prune=20000 # set if you have low disk space (in MB)

metadata.rb

@@ -0,0 +1,4 @@
+describe command('sudo -u bitcoin -- bitcoin-cli -version') do
+  its('exit_status') { should eq 0 }
+  its('stdout') { should include "Bitcoin Core RPC client" }
+end