glazed 0.1.0

data/lib/glazed/v1/workflow_pb.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: glazed/v1/workflow.proto
+
+require 'google/protobuf'
+
+require 'buf/validate/validate_pb'
+require 'glazed/v1/redaction_pb'
+require 'google/protobuf/any_pb'
+
+
+descriptor_data = "\n\x18glazed/v1/workflow.proto\x12\tglazed.v1\x1a\x1b\x62uf/validate/validate.proto\x1a\x19glazed/v1/redaction.proto\x1a\x19google/protobuf/any.proto\"\x9d\x01\n\x08Workflow\x12/\n\x05steps\x18\x01 \x03(\x0b\x32\x0f.glazed.v1.StepB\x08\xbaH\x05\x92\x01\x02\x08\x01R\x05steps:`\xbaH]\x1a[\n\x1aworkflow.unique_step_names\x12\x19step names must be unique\x1a\"this.steps.map(s, s.name).unique()\"\xe3\x02\n\x04Step\x12\x1b\n\x04name\x18\x01 \x01(\tB\x07\xbaH\x04r\x02\x10\x01R\x04name\x12,\n\x05\x66\x65tch\x18\x02 \x01(\x0b\x32\x14.glazed.v1.FetchStepH\x00R\x05\x66\x65tch\x12/\n\x06redact\x18\x03 \x01(\x0b\x32\x15.glazed.v1.RedactStepH\x00R\x06redact\x12\x32\n\x07publish\x18\x04 \x01(\x0b\x32\x16.glazed.v1.PublishStepH\x00R\x07publish\x12,\n\x05shell\x18\x05 \x01(\x0b\x32\x14.glazed.v1.ShellStepH\x00R\x05shell\x12<\n\x0b\x62\x61tch_shell\x18\x06 \x01(\x0b\x32\x19.glazed.v1.BatchShellStepH\x00R\nbatchShell\x12.\n\x06plugin\x18\x07 \x01(\x0b\x32\x14.google.protobuf.AnyH\x00R\x06pluginB\x0f\n\x06\x61\x63tion\x12\x05\xbaH\x02\x08\x01\"x\n\tFetchStep\x12\x1f\n\x06output\x18\x01 \x01(\tB\x07\xbaH\x04r\x02\x10\x01R\x06output\x12!\n\x07storage\x18\x02 \x01(\tB\x07\xbaH\x04r\x02\x10\x01R\x07storage\x12\'\n\x0ftimeout_seconds\x18\x03 \x01(\rR\x0etimeoutSeconds\"\xa3\x01\n\nRedactStep\x12\x1d\n\x05input\x18\x01 \x01(\tB\x07\xbaH\x04r\x02\x10\x01R\x05input\x12\x1f\n\x06output\x18\x02 \x01(\tB\x07\xbaH\x04r\x02\x10\x01R\x06output\x12!\n\x07storage\x18\x03 \x01(\tB\x07\xbaH\x04r\x02\x10\x01R\x07storage\x12\x32\n\tredaction\x18\x04 \x01(\x0b\x32\x14.glazed.v1.RedactionR\tredaction\"g\n\x0bPublishStep\x12\x1d\n\x05input\x18\x01 \x01(\tB\x07\xbaH\x04r\x02\x10\x01R\x05input\x12!\n\x07storage\x18\x02 \x01(\tB\x07\xbaH\x04r\x02\x10\x01R\x07storage\x12\x16\n\x06output\x18\x03 \x01(\tR\x06output\"\x86\x02\n\tShellStep\x12\x19\n\x03run\x18\x01 \x01(\tB\x07\xbaH\x04r\x02\x10\x01R\x03run\x12\x14\n\x05input\x18\x02 \x01(\tR\x05input\x12\x16\n\x06output\x18\x03 \x01(\tR\x06output\x12\x18\n\x07storage\x18\x04 \x01(\tR\x07storage\x12\'\n\x0ftimeout_seconds\x18\x05 \x01(\rR\x0etimeoutSeconds:m\xbaHj\x1ah\n\x19shell_step.output_storage\x12\x1eoutput and storage go together\x1a+(this.output == \'\') == (this.storage == \'\')\"T\n\x0e\x42\x61tchShellStep\x12\x19\n\x03run\x18\x01 \x01(\tB\x07\xbaH\x04r\x02\x10\x01R\x03run\x12\'\n\x0ftimeout_seconds\x18\x02 \x01(\rR\x0etimeoutSecondsB\x14\xea\x02\x11Glazed::Proto::V1b\x06proto3"
+
+pool = ::Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Glazed
+  module Proto
+    module V1
+      Workflow = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("glazed.v1.Workflow").msgclass
+      Step = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("glazed.v1.Step").msgclass
+      FetchStep = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("glazed.v1.FetchStep").msgclass
+      RedactStep = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("glazed.v1.RedactStep").msgclass
+      PublishStep = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("glazed.v1.PublishStep").msgclass
+      ShellStep = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("glazed.v1.ShellStep").msgclass
+      BatchShellStep = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("glazed.v1.BatchShellStep").msgclass
+    end
+  end
+end

data/lib/glazed/validation.rb

@@ -0,0 +1,31 @@
+# typed: strict
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: Apache-2.0
+
+require 'google/protobuf'
+require 'protovalidate'
+require 'glazed'
+
+module Glazed
+  # Raised when a message breaks the buf.validate rules of its schema.
+  class InvalidMessage < Error; end
+
+  # Checks messages against the buf.validate rules declared in their schema,
+  # including rules plugin gems declare for their settings.
+  module Validation
+    # @param message [Google::Protobuf::MessageExts] message to check
+    # @param origin [String, nil] where the message comes from, for the error message
+    # @return [void]
+    # @raise [InvalidMessage] listing every violation
+    # @example
+    #   Glazed::Validation.validate!(config, origin: 'glazed.json')
+    #: (Google::Protobuf::MessageExts message, ?origin: String?) -> void
+    def self.validate!(message, origin: nil)
+      Protovalidate.validate(message)
+    rescue Protovalidate::ValidationError => e
+      details = e.violations.join('; ')
+      raise InvalidMessage, origin ? "#{origin}: #{details}" : details
+    end
+  end
+end

data/lib/glazed/version.rb

@@ -0,0 +1,9 @@
+# typed: strict
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: Apache-2.0
+
+module Glazed
+  # Gem version.
+  VERSION = '0.1.0' #: String
+end

data/lib/glazed/workflow.rb

@@ -0,0 +1,70 @@
+# typed: strict
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: Apache-2.0
+
+require 'glazed'
+require 'glazed/proto'
+require 'glazed/steps'
+require 'glazed/validation'
+
+module Glazed
+  # Ordered, validated steps built from a {Proto::V1::Workflow}.
+  #
+  # @example
+  #   context = Glazed::StepContext.from_proto(config.storages)
+  #   workflow = Glazed::Workflow.from_proto(config.workflows.fetch('backup'), context:)
+  class Workflow
+    # Raised when steps are wired inconsistently.
+    class Invalid < Glazed::Error; end
+
+    # @param steps [Array<Steps::Base>] steps in order
+    # @raise [Invalid] when there are no steps, step names repeat, an input is
+    #   not produced by an earlier step, or an output is produced twice
+    #: (steps: Array[Steps::Base]) -> void
+    def initialize(steps:)
+      @steps = steps.freeze #: Array[Steps::Base]
+      validate
+    end
+
+    # Builds every step of a workflow definition.
+    #
+    # @param workflow [Proto::V1::Workflow] workflow definition
+    # @param context [StepContext] named storages
+    # @return [Workflow] the workflow
+    # @raise [InvalidMessage] when the definition breaks the rules of its schema
+    # @raise [Invalid] when steps are wired inconsistently
+    # @raise [StepContext::UnknownStorage] when a step names an unknown storage
+    #: (Proto::V1::Workflow workflow, context: StepContext) -> Workflow
+    def self.from_proto(workflow, context:)
+      Validation.validate!(workflow)
+      new(steps: workflow.steps.map { Steps.build(it, context:) })
+    end
+
+    # @return [Array<Steps::Base>] steps in order
+    #: Array[Steps::Base]
+    attr_reader :steps
+
+    # @return [void]
+    # @raise [Invalid] when steps are wired inconsistently
+    #: () -> void
+    private def validate
+      raise Invalid, 'workflow has no steps' if steps.empty?
+
+      names = steps.map(&:name)
+      duplicated = names.select { names.count(it) > 1 }.uniq
+      raise Invalid, "step names repeat: #{duplicated.join(', ')}" unless duplicated.empty?
+
+      available = [] #: Array[String]
+      steps.each do |step|
+        missing = step.inputs - available
+        raise Invalid, "#{step.name}: no earlier step produces #{missing.join(', ')}" unless missing.empty?
+
+        repeated = step.outputs & available
+        raise Invalid, "#{step.name}: #{repeated.join(', ')} is already produced" unless repeated.empty?
+
+        available.concat(step.outputs)
+      end
+    end
+  end
+end

data/lib/glazed.rb

@@ -0,0 +1,18 @@
+# typed: strict
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: Apache-2.0
+
+require_relative 'glazed/version'
+
+# Network device configuration scraper.
+module Glazed
+  # Base class for errors raised by glazed.
+  class Error < StandardError; end
+  # Raised when a device does not produce expected output in time.
+  class TimeoutError < Error; end
+  # Raised when a device closes the connection unexpectedly.
+  class ConnectionClosed < Error; end
+  # Raised when collected configuration is not valid UTF-8.
+  class InvalidEncoding < Error; end
+end

metadata

@@ -0,0 +1,245 @@
+--- !ruby/object:Gem::Specification
+name: glazed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sorah Fukumori
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  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: google-protobuf
+  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: httpx
+  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: logger
+  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: net-ssh
+  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: net-telnet
+  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: protovalidate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0.beta3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0.beta3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+email:
+- her@sorah.jp
+executables:
+- glazed
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE.txt
+- NOTICE
+- README.md
+- Rakefile
+- exe/glazed
+- lib/glazed.rb
+- lib/glazed/cli_session.rb
+- lib/glazed/collector.rb
+- lib/glazed/command.rb
+- lib/glazed/command/base.rb
+- lib/glazed/command/orchestrate.rb
+- lib/glazed/command/run.rb
+- lib/glazed/command/send_signal.rb
+- lib/glazed/command/status.rb
+- lib/glazed/command/version.rb
+- lib/glazed/command_result.rb
+- lib/glazed/dialect.rb
+- lib/glazed/dialect/actions.rb
+- lib/glazed/dialect/communication_config.rb
+- lib/glazed/dialect/interaction.rb
+- lib/glazed/dialect/run.rb
+- lib/glazed/dialect/runbook.rb
+- lib/glazed/dialect/sensitive_pattern.rb
+- lib/glazed/dialects.rb
+- lib/glazed/dialects/awplus.rb
+- lib/glazed/dialects/base.rb
+- lib/glazed/dialects/ios.rb
+- lib/glazed/dialects/junos.rb
+- lib/glazed/dialects/nec_ix.rb
+- lib/glazed/dialects/wlc.rb
+- lib/glazed/finder.rb
+- lib/glazed/must.rb
+- lib/glazed/orchestrator.rb
+- lib/glazed/orchestrator/policy.rb
+- lib/glazed/plugin_registry.rb
+- lib/glazed/proto.rb
+- lib/glazed/proto_json.rb
+- lib/glazed/redactor.rb
+- lib/glazed/runner.rb
+- lib/glazed/secret.rb
+- lib/glazed/secrets.rb
+- lib/glazed/shell_command.rb
+- lib/glazed/sources.rb
+- lib/glazed/sources/base.rb
+- lib/glazed/sources/command.rb
+- lib/glazed/sources/inline.rb
+- lib/glazed/sources/json_files.rb
+- lib/glazed/state_backends.rb
+- lib/glazed/state_backends/base.rb
+- lib/glazed/state_backends/sqlite.rb
+- lib/glazed/step_context.rb
+- lib/glazed/steps.rb
+- lib/glazed/steps/base.rb
+- lib/glazed/steps/batch_shell.rb
+- lib/glazed/steps/fetch.rb
+- lib/glazed/steps/publish.rb
+- lib/glazed/steps/redact.rb
+- lib/glazed/steps/shell.rb
+- lib/glazed/storages.rb
+- lib/glazed/storages/base.rb
+- lib/glazed/storages/filesystem.rb
+- lib/glazed/storages/git.rb
+- lib/glazed/storages/github.rb
+- lib/glazed/storages/memory.rb
+- lib/glazed/transports.rb
+- lib/glazed/transports/base.rb
+- lib/glazed/transports/ssh.rb
+- lib/glazed/transports/telnet.rb
+- lib/glazed/v1/config_pb.rb
+- lib/glazed/v1/inventory_pb.rb
+- lib/glazed/v1/orchestrator_pb.rb
+- lib/glazed/v1/redaction_pb.rb
+- lib/glazed/v1/secret_pb.rb
+- lib/glazed/v1/state_pb.rb
+- lib/glazed/v1/steps_pb.rb
+- lib/glazed/v1/storage_pb.rb
+- lib/glazed/v1/workflow_pb.rb
+- lib/glazed/validation.rb
+- lib/glazed/version.rb
+- lib/glazed/workflow.rb
+homepage: https://github.com/sorah/glazed
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/sorah/glazed
+  source_code_uri: https://github.com/sorah/glazed/tree/main/glazed
+  changelog_uri: https://github.com/sorah/glazed/blob/main/glazed/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Network device configuration scraper, a modern successor of oxidized
+test_files: []