cardano-up 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dc6e5153ea10a283c8076a763034d89334e0ec285265ce8fa47cb7d41dddbaa
-  data.tar.gz: fc58a1646113ff3c52faaadb6807f1147029a4716d06b750f07783041eac4149
+  metadata.gz: 26ea3b59240dc0a0c2eca674edf54ba66fba8e8bb276f40f1f3aecd4b1e13c8b
+  data.tar.gz: 0f278da8551b805df01aa2c714fdfbba1272b5af3edea3e8101821a1cdae3263
 SHA512:
-  metadata.gz: e098510d7c479a9d1570c1f9ba803875908b509365b556045c8530f1548e13356593592c3985c30d6711c84c2afd077b54cd417bf5eba0505590bb9b1b6fb30d
-  data.tar.gz: 54d8a545a3f1ebdea7cca06829672c337de7eac3403469d6ed33033869e7e08431b86dd495be49def0359063d004c0a363fdba397a8cd69ef4852d852582aa92
+  metadata.gz: 8c4f5f88c56f90fcc20e3b78bc994a2067760d70698f2bca1a4619d4b6fc809433fe6404776a0962c8be62b77ab08a41b1348589427a74631b79043c56f10bf5
+  data.tar.gz: 6796a8d67a93cbb5b0b99a2d8b0c97f9416baefb67e911b50b46ccd6a0c3177f68dac2039a58210460e47668099f7814a6bc2cc68898d8f5b3edcaba2f59c850

data/README.md

@@ -23,7 +23,19 @@ This Ruby gem provides easy way for:
 
 ## Installation
 
+#### Rubygem:
+
     $ gem install cardano-up
+    $ cardano-up --help
+
+#### Nix:
+
+    $ nix develop github:piotr-iohk/cardano-up?dir=nix
+    $ cardano-up --help
+
+or run directly
+
+    $ nix run github:piotr-iohk/cardano-up?dir=nix -- --help
 
 ## Usage
 
@@ -52,7 +64,7 @@ By default cardano-up keeps all files at `$HOME/.cardano-up/` however this can b
 
 **Configurations** for the networks are downloaded from [Cardano Book](https://book.world.dev.cardano.org/environments.html).
 
-**Binaries** come from [cardano-wallet](https://github.com/input-output-hk/cardano-wallet) which actually provides `cardano-node`, `cardano-cli`, `cardano-wallet`, `cardano-addresses` and `bech32` tools in each of its release bundles. This ensures that all components are compatible and work smoothly together. You can get any public release of the cardano-wallet bundle as well as `master` version and even any of the PRs that are currently being worked on.
+**Binaries** come from [cardano-wallet](https://github.com/input-output-hk/cardano-wallet) which actually provides `cardano-node`, `cardano-cli`, `cardano-wallet`, `cardano-addresses` and `bech32` tools in each of its release bundles. This ensures that all components are compatible and work smoothly together. You can get any public release of the cardano-wallet bundle. 
 
 **Starting** `cardano-node` and `cardano-wallet`,  cardano-up attempts to launch separate [`screen`](https://www.gnu.org/software/screen/) sessions for wallet and node respectively. If screen is not present on your system you can install it using package manager, e.g.:
 

data/bin/cardano-up

@@ -14,14 +14,14 @@ doc = <<~DOCOPT
     #{File.basename(__FILE__)} ls
     #{File.basename(__FILE__)} config [--set-default] [--bindir <path>] [--configdir <path>] [--logdir <path>] [--statedir <path>]
     #{File.basename(__FILE__)} <env> [(node|wallet)] [(up|down|ping)] [--port <port>] [--session <name>]
-    #{File.basename(__FILE__)} <env> (node|wallet) tail [--session <name>]
+    #{File.basename(__FILE__)} <env> (node|wallet) tail [--lines <num_lines>] [--session <name>]
     #{File.basename(__FILE__)} -v | --version
     #{File.basename(__FILE__)} -e | --examples
     #{File.basename(__FILE__)} -h | --help
 
   Options:
     install                 Install cardano-node, cardano-cli, cardano-wallet, cardano-addresses and bech32.
-    <release>               latest | release tag | master | pr num. [default: latest]
+    <release>               latest | release tag [default: latest]
     get-configs             Get configs for particular Cardano environment.
     <env>                   mainnet | preview | preprod etc.
     up                      Start particular service. If any configs are missing #{File.basename(__FILE__)}
@@ -29,6 +29,7 @@ doc = <<~DOCOPT
                             ones from latest release.
     down                    Stop particular service.
     tail                    Follow logs for particular service.
+    -n --lines <num_lines>  Number of lines to show from the end of the log file. [default: 10]
     ping                    Ping service to check its status.
     ls                      List sessions.
     -p --port <port>        Specify wallet port. [default: 8090]
@@ -122,7 +123,7 @@ Check health of node and wallet on mainnet:
 Monitor mainnet wallet and node logs (Ctrl + c to stop):
 
     $ #{File.basename(__FILE__)} mainnet node tail
-    $ #{File.basename(__FILE__)} mainnet wallet tail
+    $ #{File.basename(__FILE__)} mainnet wallet tail -n 100
 
 Stop preprod node:
 
@@ -261,7 +262,7 @@ Stop mainnet node and wallet:
         $stderr.puts
         warn "Congratulations! You've just started cardano-node and cardano-wallet!"
       end
-    rescue CardanoUp::EnvNotSupportedError => e
+    rescue CardanoUp::EnvNotSupportedError, CardanoUp::NoScreenError => e
       warn "⚠️   #{e}"
       exit 1
     rescue CardanoUp::SessionHasNodeError => e
@@ -307,7 +308,7 @@ Stop mainnet node and wallet:
         end
         warn 'Wallet stopped.'
       end
-    rescue CardanoUp::EnvNotSupportedError, CardanoUp::SessionNotExistsError => e
+    rescue CardanoUp::EnvNotSupportedError, CardanoUp::SessionNotExistsError, CardanoUp::NoScreenError => e
       warn "⚠️   #{e}"
       exit 1
     end
@@ -316,14 +317,15 @@ Stop mainnet node and wallet:
   elsif o['tail'] == true
     env = o['<env>']
     session_name = o['--session']
+    lines = o['--lines'].to_i
     begin
       log_dir = File.join(CardanoUp.config[:log_dir], session_name, env)
       if o['node']
         log_file = File.join(log_dir, 'node.log')
-        CardanoUp::Tail.tail(log_file)
+        CardanoUp::Tail.tail(log_file, lines)
       elsif o['wallet']
         log_file = File.join(log_dir, 'wallet.log')
-        CardanoUp::Tail.tail(log_file)
+        CardanoUp::Tail.tail(log_file, lines)
       end
     rescue CardanoUp::EnvNotSupportedError => e
       warn(e.message)

data/lib/cardano-up/bins.rb

@@ -4,7 +4,7 @@ module CardanoUp
   # Installing binaries for Cardano
   module Bins
     # Get cardano-wallet bundle binaries to your computer.
-    # @param release [String] - 'latest' | /^v20.{2}-.{2}-.{2}/ | 'master' | '3341'
+    # @param release [String] - 'latest' | /^v20.{2}-.{2}-.{2}/
     # @raise CardanoUp::VersionNotSupportedError
     def self.install(release)
       CardanoUp.configure_default unless CardanoUp.configured?

data/lib/cardano-up/err.rb

@@ -67,8 +67,15 @@ module CardanoUp
   # Thrown when version of bundle to download is not supported
   class VersionNotSupportedError < StandardError
     def initialize(ver)
-      super(["Not supported version: #{ver}. Supported are: 'latest', 'master',",
-             "tag (e.g. 'v2022-08-16') or pr number ('3045')"].join(' '))
+      super(["Not supported version: #{ver}. Supported are: 'latest' or",
+             "tag (e.g. 'v2022-08-16')"].join(' '))
+    end
+  end
+
+  # Thrown when there is no screen on the system
+  class NoScreenError < StandardError
+    def initialize
+      super('There is no screen tool on the system!')
     end
   end
 end

data/lib/cardano-up/launcher.rb

@@ -73,6 +73,7 @@ module CardanoUp
     # @param configuration [Hash] output of setup
     # @raise CardanoUp::SessionHasNodeError
     # @raise CardanoUp::SessionHasWalletError
+    # @raise CardanoUp::NoScreenError
     def self.node_up(configuration)
       env = configuration[:env]
       bin_dir = configuration[:bin_dir]
@@ -82,6 +83,8 @@ module CardanoUp
       node_socket = configuration[:node_socket]
       session_name = configuration[:session_name]
 
+      raise CardanoUp::NoScreenError if !CardanoUp::Utils.win? && !CardanoUp::Utils.screen?
+
       exe = CardanoUp::Utils.win? ? '.exe' : ''
       cardano_node = "#{File.join(bin_dir, 'cardano-node')}#{exe}"
       version = CardanoUp::Utils.cmd "#{cardano_node} version"
@@ -146,11 +149,15 @@ module CardanoUp
     end
 
     # @param configuration [Hash] output of setup
+    # @raise CardanoUp::NoScreenError
+    # @raise CardanoUp::WalletPortUsedError
     def self.wallet_up(configuration)
       if CardanoUp::Utils.port_used?(configuration[:wallet_port].to_i)
         raise CardanoUp::WalletPortUsedError, configuration[:wallet_port]
       end
 
+      raise CardanoUp::NoScreenError if !CardanoUp::Utils.win? && !CardanoUp::Utils.screen?
+
       env = configuration[:env]
       wallet_port = configuration[:wallet_port]
       token_metadata_server = configuration[:token_metadata_server]
@@ -211,9 +218,12 @@ module CardanoUp
     end
 
     # @raise CardanoUp::EnvNotSupportedError
+    # @raise CardanoUp::NoScreenError
     def self.node_down(env, session_name = '0')
       raise CardanoUp::EnvNotSupportedError, env unless CardanoUp::ENVS.include? env
 
+      raise CardanoUp::NoScreenError if !CardanoUp::Utils.win? && !CardanoUp::Utils.screen?
+
       if CardanoUp::Utils.win?
         CardanoUp::Utils.cmd "nssm stop cardano-node-#{env}-#{session_name}"
         CardanoUp::Utils.cmd "nssm remove cardano-node-#{env}-#{session_name} confirm"
@@ -225,9 +235,12 @@ module CardanoUp
     end
 
     # @raise CardanoUp::EnvNotSupportedError
+    # @raise CardanoUp::NoScreenError
     def self.wallet_down(env, session_name = '0')
       raise CardanoUp::EnvNotSupportedError, env unless CardanoUp::ENVS.include? env
 
+      raise CardanoUp::NoScreenError if !CardanoUp::Utils.win? && !CardanoUp::Utils.screen?
+
       if CardanoUp::Utils.win?
         CardanoUp::Utils.cmd "nssm stop cardano-wallet-#{env}-#{session_name}"
         CardanoUp::Utils.cmd "nssm remove cardano-wallet-#{env}-#{session_name} confirm"

data/lib/cardano-up/tail.rb

@@ -3,11 +3,12 @@
 module CardanoUp
   # Tail log file
   module Tail
-    def self.tail(file_path)
+    def self.tail(file_path, lines = nil)
+      lines_back = lines || 10
       File.open(file_path) do |log|
         log.extend(File::Tail)
         log.interval
-        log.backward(10)
+        log.backward(lines_back.to_i)
         log.tail { |line| warn line }
       end
     end

data/lib/cardano-up/utils.rb

@@ -11,6 +11,11 @@ module CardanoUp
       res.gsub("\n", ' ').strip
     end
 
+    # Check if screen command is available
+    def self.screen?
+      cmd('which screen').chomp.length.positive?
+    end
+
     def self.wget(url, file = nil)
       file ||= File.basename(url)
       resp = HTTParty.get(url)
@@ -61,40 +66,21 @@ module CardanoUp
 
     ##
     # Latest binary url for latest release or particular tag, from master or pr num.
-    # @param release [String] - 'latest' | /^v20.{2}-.{2}-.{2}/ | 'master' | '3341'
+    # @param release [String] - 'latest' | /^v20.{2}-.{2}-.{2}/
     # @raise CardanoUp::VersionNotSupportedError
     def self.get_binary_url(release = 'latest')
-      unless release == 'master' || release == 'latest' || release =~ /^v20.{2}-.{2}-.{2}/ || release =~ /^\d+$/
-        raise CardanoUp::VersionNotSupportedError, release
+      raise CardanoUp::VersionNotSupportedError, release unless release == 'latest' || release =~ /^v20.{2}-.{2}-.{2}/
+
+      tag = release == 'latest' ? latest_tag : release
+      if linux?
+        file = "cardano-wallet-#{tag}-linux64.tar.gz"
+      elsif mac?
+        file = "cardano-wallet-#{tag}-macos-intel.tar.gz"
+      elsif win?
+        file = "cardano-wallet-#{tag}-win64.zip"
       end
 
-      url = ''
-      if release == 'latest' || release =~ /^v20.{2}-.{2}-.{2}/
-        tag = release == 'latest' ? latest_tag : release
-        if linux?
-          file = "cardano-wallet-#{tag}-linux64.tar.gz"
-        elsif mac?
-          file = "cardano-wallet-#{tag}-macos-intel.tar.gz"
-        elsif win?
-          file = "cardano-wallet-#{tag}-win64.zip"
-        end
-        url = "#{CardanoUp::BINS_BASE_URL}/releases/download/#{tag}/#{file}"
-      else
-        if linux?
-          os = 'linux.musl.cardano-wallet-linux64'
-        elsif mac?
-          os = 'macos.intel.cardano-wallet-macos-intel'
-        elsif win?
-          os = 'linux.windows.cardano-wallet-win64'
-        end
-
-        url = if release == 'master'
-                "#{CardanoUp::HYDRA_BASE_URL}/#{os}/latest/download-by-type/file/binary-dist"
-              else
-                "#{CardanoUp::HYDRA_BASE_URL}-pr-#{release}/#{os}/latest/download-by-type/file/binary-dist"
-              end
-      end
-      url
+      "#{CardanoUp::BINS_BASE_URL}/releases/download/#{tag}/#{file}"
     end
 
     ##

data/lib/cardano-up/version.rb

@@ -2,5 +2,5 @@
 
 # Version
 module CardanoUp
-  VERSION ||= '0.1.2'
+  VERSION ||= '0.1.4'
 end

data/lib/cardano-up.rb

@@ -27,7 +27,6 @@ require 'cardano-up/tail'
 module CardanoUp
   CONFIGS_BASE_URL = 'https://book.world.dev.cardano.org/environments'
   BINS_BASE_URL = 'https://github.com/input-output-hk/cardano-wallet'
-  HYDRA_BASE_URL = 'https://hydra.iohk.io/job/Cardano/cardano-wallet'
   ENVS = %w[mainnet preview preprod shelley-qa
             staging vasil-qa vasil-dev mixed testnet].freeze
   CONFIG_FILES = ['alonzo-genesis.json', 'byron-genesis.json', 'shelley-genesis.json',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cardano-up
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Piotr Stachyra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-15 00:00:00.000000000 Z
+date: 2023-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.21.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: '1.46'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: '1.46'
 description: |-
   Cardano Up lets you get all essential Cardano
                           tools on your system: cardano-node, cardano-cli, cardano-wallet,
@@ -162,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Lightweight manager for Cardano binaries and configs.