train-juniper 0.7.0 → 0.7.3

data/lib/train-juniper/file_abstraction/juniper_file.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'train-juniper/constants'
+
+module TrainPlugins
+  module Juniper
+    # File abstraction for Juniper configuration and operational data
+    class JuniperFile
+      # Initialize a new JuniperFile
+      # @param connection [Connection] The Juniper connection instance
+      # @param path [String] The virtual file path
+      def initialize(connection, path)
+        @connection = connection
+        @path = path
+      end
+
+      # Get the content of the virtual file
+      # @return [String] The command output based on the path
+      # @example
+      #   file = connection.file('/config/interfaces')
+      #   file.content  # Returns output of 'show configuration interfaces'
+      def content
+        # For Juniper devices, translate file paths to appropriate commands
+        case @path
+        when Constants::CONFIG_PATH_PATTERN
+          # Configuration sections: /config/interfaces -> show configuration interfaces
+          section = ::Regexp.last_match(1)
+          result = @connection.run_command("show configuration #{section}")
+          result.stdout
+        when Constants::OPERATIONAL_PATH_PATTERN
+          # Operational data: /operational/interfaces -> show interfaces
+          section = ::Regexp.last_match(1)
+          result = @connection.run_command("show #{section}")
+          result.stdout
+        else
+          # Default to treating path as a show command
+          result = @connection.run_command("show #{@path}")
+          result.stdout
+        end
+      end
+
+      # Check if the file exists (has content)
+      # @return [Boolean] true if the file has content, false otherwise
+      def exist?
+        !content.empty?
+      rescue StandardError
+        false
+      end
+
+      # Return string representation of file path
+      # @return [String] the file path
+      def to_s
+        @path
+      end
+
+      # File upload not supported for network devices
+      # @raise [NotImplementedError] always raises as upload is not supported
+      def upload(_content)
+        raise NotImplementedError, Constants::UPLOAD_NOT_SUPPORTED
+      end
+
+      # File download not supported for network devices
+      # @raise [NotImplementedError] always raises as download is not supported
+      def download(_local_path)
+        raise NotImplementedError, Constants::DOWNLOAD_NOT_SUPPORTED
+      end
+    end
+  end
+end

data/lib/train-juniper/helpers/environment.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module TrainPlugins
+  module Juniper
+    # Helper methods for safely handling environment variables
+    module Environment
+      # Helper method to safely get environment variable value
+      # Returns nil if env var is not set or is empty string
+      # @param key [String] The environment variable name
+      # @return [String, nil] The value or nil if not set/empty
+      def env_value(key)
+        value = ENV.fetch(key, nil)
+        return nil if value.nil? || value.empty?
+
+        value
+      end
+
+      # Helper method to get environment variable as integer
+      # Returns nil if env var is not set, empty, or not a valid integer
+      # @param key [String] The environment variable name
+      # @return [Integer, nil] The integer value or nil if not valid
+      def env_int(key)
+        value = env_value(key)
+        return nil unless value
+
+        value.to_i
+      end
+    end
+  end
+end

data/lib/train-juniper/helpers/logging.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module TrainPlugins
+  module Juniper
+    # Provides consistent logging patterns across the plugin
+    module Logging
+      # Log a command execution attempt
+      # @param cmd [String] The command being executed
+      def log_command(cmd)
+        @logger.debug("Executing command: #{cmd}")
+      end
+
+      # Log a connection attempt
+      # @param target [String] The host/target being connected to
+      # @param port [Integer] The port number
+      def log_connection_attempt(target, port = nil)
+        if port
+          @logger.debug("Attempting connection to #{target}:#{port}")
+        else
+          @logger.debug("Attempting connection to #{target}")
+        end
+      end
+
+      # Log an error with consistent formatting
+      # @param error [Exception, String] The error to log
+      # @param context [String] Additional context for the error
+      def log_error(error, context = nil)
+        message = if error.is_a?(Exception)
+                    "#{error.class}: #{error.message}"
+                  else
+                    error.to_s
+                  end
+
+        if context
+          @logger.error("#{context}: #{message}")
+        else
+          @logger.error(message)
+        end
+      end
+
+      # Log successful connection
+      # @param target [String] The host that was connected to
+      def log_connection_success(target)
+        @logger.info("Successfully connected to #{target}")
+      end
+
+      # Log SSH session details (redacting sensitive info)
+      # @param options [Hash] SSH options hash
+      def log_ssh_options(options)
+        safe_options = options.dup
+        safe_options[:password] = '[REDACTED]' if safe_options[:password]
+        safe_options[:passphrase] = '[REDACTED]' if safe_options[:passphrase]
+        safe_options[:keys] = safe_options[:keys]&.map { |k| File.basename(k) } if safe_options[:keys]
+
+        @logger.debug("SSH options: #{safe_options.inspect}")
+      end
+
+      # Log platform detection results
+      # @param platform_name [String] Detected platform name
+      # @param version [String] Detected version
+      def log_platform_detection(platform_name, version)
+        @logger.info("Platform detected: #{platform_name} #{version}")
+      end
+
+      # Log bastion connection attempt
+      # @param bastion_host [String] The bastion host
+      def log_bastion_connection(bastion_host)
+        @logger.debug("Connecting through bastion host: #{bastion_host}")
+      end
+
+      # Log mock mode activation
+      def log_mock_mode
+        @logger.info('Running in mock mode - no real device connection')
+      end
+    end
+  end
+end

data/lib/train-juniper/helpers/mock_responses.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Mock responses for Juniper device commands
+# This module contains all mock data used in testing and mock mode
+module TrainPlugins
+  module Juniper
+    # Mock responses for common JunOS commands
+    # Used when running in mock mode for testing without real devices
+    module MockResponses
+      # Configuration of mock responses
+      # Maps command patterns to response methods or strings
+      RESPONSES = {
+        'show version' => :mock_show_version_output,
+        'show chassis hardware' => :mock_chassis_output,
+        'show configuration' => "interfaces {\n    ge-0/0/0 {\n        unit 0;\n    }\n}",
+        'show route' => "inet.0: 5 destinations, 5 routes\n0.0.0.0/0       *[Static/5] 00:00:01\n",
+        'show system information' => "Hardware: SRX240H2\nOS: JUNOS 12.1X47-D15.4\n",
+        'show interfaces' => "Physical interface: ge-0/0/0, Enabled, Physical link is Up\n"
+      }.freeze
+
+      # Mock JunOS version output for testing
+      # @return [String] mock output for 'show version' command
+      def self.mock_show_version_output
+        <<~OUTPUT
+          Hostname: lab-srx
+          Model: SRX240H2
+          Junos: 12.1X47-D15.4
+          JUNOS Software Release [12.1X47-D15.4]
+        OUTPUT
+      end
+
+      # Mock chassis hardware output
+      # @return [String] mock output for 'show chassis hardware' command
+      def self.mock_chassis_output
+        <<~OUTPUT
+          Hardware inventory:
+          Item             Version  Part number  Serial number     Description
+          Chassis                                JN123456          SRX240H2
+        OUTPUT
+      end
+
+      # Get mock response for a command
+      # @param cmd [String] the command to get response for
+      # @return [Array<String, Integer>] tuple of [output, exit_status]
+      def self.response_for(cmd)
+        response = RESPONSES.find { |pattern, _| cmd.match?(/#{pattern}/) }
+
+        if response
+          output = response[1].is_a?(Symbol) ? send(response[1]) : response[1]
+          [output, 0]
+        else
+          ["% Unknown command: #{cmd}", 1]
+        end
+      end
+    end
+  end
+end

data/lib/train-juniper/platform.rb

@@ -42,6 +42,9 @@ module TrainPlugins::Juniper
       platform_obj = force_platform!(PLATFORM_NAME, platform_details)
       logger&.debug("Set platform data: #{platform_obj.platform}")
 
+      # Log platform detection results if logging helpers available
+      log_platform_detection(PLATFORM_NAME, device_version) if respond_to?(:log_platform_detection)
+
       # Cache the platform object to prevent repeated calls
       @platform = platform_obj
     end

data/lib/train-juniper/version.rb

@@ -8,6 +8,6 @@
 module TrainPlugins
   module Juniper
     # Version number of the train-juniper plugin
-    VERSION = '0.7.0'
+    VERSION = '0.7.3'
   end
 end

data/train-juniper.gemspec

@@ -68,8 +68,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'net-ssh', '>= 2.9', '< 8.0'
 
   # FFI dependency - required by train-core
-  # Match InSpec 7's FFI version range for compatibility
-  spec.add_dependency 'ffi', '>= 1.15.5', '< 1.17.0'
+  # Updated to support Ruby 3.3 on Windows (ffi 1.17.x required)
+  spec.add_dependency 'ffi', '>= 1.15.5', '< 1.18.0'
 
   # Development dependencies
   spec.add_development_dependency 'bundler', '~> 2.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: train-juniper
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.3
 platform: ruby
 authors:
 - MITRE Corporation
@@ -53,7 +53,7 @@ dependencies:
         version: 1.15.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: 1.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,7 +63,7 @@ dependencies:
         version: 1.15.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: 1.18.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -224,6 +224,16 @@ files:
 - SECURITY.md
 - lib/train-juniper.rb
 - lib/train-juniper/connection.rb
+- lib/train-juniper/connection/bastion_proxy.rb
+- lib/train-juniper/connection/command_executor.rb
+- lib/train-juniper/connection/error_handling.rb
+- lib/train-juniper/connection/ssh_session.rb
+- lib/train-juniper/connection/validation.rb
+- lib/train-juniper/constants.rb
+- lib/train-juniper/file_abstraction/juniper_file.rb
+- lib/train-juniper/helpers/environment.rb
+- lib/train-juniper/helpers/logging.rb
+- lib/train-juniper/helpers/mock_responses.rb
 - lib/train-juniper/platform.rb
 - lib/train-juniper/transport.rb
 - lib/train-juniper/version.rb