facter-statistax 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6971418a5d73bc74457815e68c51cf6b6196fb099bae62d158a6556bcb92f30b
+  data.tar.gz: 0d7f68a92fe26b421c5492456bf6a422f194ac1be392df76ff9a61afc2a8c298
+SHA512:
+  metadata.gz: 81c054c110161cb65539ed7514d8d0c4d1d1156fdd9fe3a3511bac2bf98770a856b27fc2f8d228818ea7c62173bd679fcf8edbcc942eb72bd095ee372c9acde4
+  data.tar.gz: 44557b69d400fe52af8cb74716359ced45bce2ffff7070da4fc65425fac3bc9602da3a01865203ed6f5c28079fb9dc4b4945577af8bc953c96fc08d789e03ac3

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  Include:
+    - 'lib/**/*.rb'
+
+Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120

data/.rubycritic.yml

@@ -0,0 +1,4 @@
+paths: # Files to analyse.
+  - 'lib'
+  - 'bin'
+  - 'config'

data/.travis.yml

@@ -0,0 +1,19 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.6
+  - 2.5
+  - 2.4
+  - 2.3
+cache:
+  bundler: true
+before_install:
+  - gem update --system
+  - gem install bundler
+
+branches:
+  only:
+    - master
+script:
+  - bundle exec rubocop
+  - bundle exec rubycritic --no-browser -s 90 -f console

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'logger'
+gem 'fileutils'
+gem 'rubysl-open3'
+gem 'json'
+gem 'pry'
+gem 'rubocop'
+gem 'rubycritic'

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,32 @@
+# facter-statistax
+Benchmark tool for different versions of Puppet Facter.
+
+In order to run this script you must create a 'config.json' file with the following format:
+
+```
+[
+  {
+    "test_run":"TestRun1",
+    "runs":[
+      {
+        "fact":"os",
+        "repetitions":3
+      },
+      {
+        "fact":"os uptime",
+        "repetitions":1
+      },
+      {
+        "fact":"all",
+        "repetitions":3
+      }
+    ]
+  }
+]
+```
+
+After you create the config file, run: ```statistax path_to_config_file (true)```.
+
+statistax.rb can receive true or false. True means that you want to measure facter gem, false is for c++ facter (the 3rd parameter is by default "false"). 
+
+You will find all the output from all runs in log/facter_statistax.log.

data/bin/statistax

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative '../lib/executors/executor'
+require_relative '../config/boot'
+
+FacterStatistax::Executors::Executor.execute

data/config/boot.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'logger'
+require 'fileutils'
+require 'open3'
+require 'json'
+require_relative '../lib/logger'
+
+ROOT_DIR      = Pathname.new(File.expand_path('..', __dir__)) unless defined?(ROOT_DIR)
+LOG_DIR       = File.join(Dir.getwd, 'log')
+SCRIPTS_DIR   = ROOT_DIR.join('scripts')
+CONFIG_FILE   = ARGV[0] || ""
+IS_GEM        = ARGV[1] || 'false'
+
+def load_files(*dirs)
+  dirs.each { |dir| Dir[ROOT_DIR.join(dir)].each { |file| require file } }
+end
+
+load_files(
+    'lib/common/*.rb',
+    'lib/executors/*.rb'
+)

data/facter-statistax.gemspec

@@ -0,0 +1,25 @@
+# # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name = "facter-statistax"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [""]
+  s.date = "2019-08-08"
+  s.description = "Benchmark for facter"
+  s.email = ""
+  s.executables = ["statistax"]
+  s.files = `git ls-files `.split("\n")
+  s.homepage = ""
+  s.rdoc_options = ["--title", "Facter-Statistax ", "--main", "README", "--line-numbers"]
+  s.require_paths = ["bin"]
+  s.rubyforge_project = "facter-statistax"
+  s.summary = "Facter-Statistax, benchmark for facter"
+
+  s.add_dependency 'logger'
+  s.add_dependency 'fileutils'
+  s.add_dependency 'rubysl-open3'
+  s.add_dependency 'json'
+end

data/lib/common/multi_logger.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module FacterStatistax
+  module Common
+    class MultiLogger
+      LEVELS = %i[debug info warn error fatal unknown].freeze
+
+      LEVELS.each do |level|
+        define_method(level) do |*args|
+          targets.map { |target| target.send(level, *args) }
+        end
+      end
+
+      def initialize(*targets)
+        @targets = targets
+      end
+
+      private
+
+      attr_reader :targets
+    end
+  end
+end

data/lib/common/output_writer.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+module FacterStatistax
+  module Common
+    class OutputWriter
+      include Singleton
+
+      attr_reader :output, :facts, :test_run
+      def initialize
+        @output = []
+        @test_run = {}
+        @facts = []
+      end
+
+      def write
+        test_run = @test_run.merge(facts: facts)
+        output << test_run
+        ::File.open(File.join(LOG_DIR, 'output.json'), 'w') do |file|
+          file.write(output.to_json)
+        end
+      end
+
+      def write_test_suite(facter_version, test_run_name)
+        @test_run = @test_run.merge(test_run_name: test_run_name, facter_gem?: facter_version)
+      end
+
+      def write_run(fact_name, time)
+        fact_name = 'all' if fact_name.empty?
+        fact = { 'name' => fact_name, 'average' => time.real }
+        facts << fact
+      end
+    end
+  end
+end

data/lib/executors/executor.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# frozen_tring_literal: true
+
+module FacterStatistax
+  module Executors
+    module Executor
+      class << self
+        def execute
+          json_writer = Common::OutputWriter.instance
+
+          read_config_file.each do |test_suite|
+            json_writer.write_test_suite(IS_GEM, test_suite.test_run)
+            log_information(IS_GEM, test_suite.test_run)
+            test_suite.runs.each do |run|
+              run_executor(run)
+            end
+          end
+          json_writer.write
+        end
+
+        private
+
+        def read_config_file
+          raise('Please define config file!') unless ::File.exist?(CONFIG_FILE)
+
+          JSON.parse(::File.read(CONFIG_FILE), object_class: OpenStruct)
+        end
+
+        def log_information(facter_version, suite_name)
+          logger.info("Begin test run: #{suite_name}")
+          logger.info("Facter gem? #{facter_version}")
+        end
+
+        def run_executor(run)
+          logger.info("Number of repetitions: #{run.repetitions}")
+          TestRunExecutor.new(run).execute
+        end
+
+        def logger
+          FacterStatistax.logger
+        end
+      end
+    end
+  end
+end

data/lib/executors/test_run_executor.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module FacterStatistax
+  module Executors
+    class TestRunExecutor
+      def initialize(run)
+        @fact = run.fact
+        @repetitions = run.repetitions
+      end
+
+      attr_reader :fact, :repetitions
+
+      def execute
+        sum = sum_for_each_repetition do
+          time, _status = Open3.capture2("ruby #{SCRIPTS_DIR}/benchmark_script.rb #{IS_GEM} #{fact}")
+          log_time(fact, time)
+          time.to_i
+        end
+        Common::OutputWriter.instance.write_run(fact, sum / repetitions)
+      end
+
+      private
+
+      def sum_for_each_repetition
+        sum = 0
+        repetitions.times do
+          time = yield
+          sum += time
+        end
+        sum
+      end
+
+      def log_time(fact, time)
+        FacterStatistax.logger.info("For #{fact} facts it took:")
+        FacterStatistax.logger.info("#{format('%.2f', time)}s")
+      end
+    end
+  end
+end

data/lib/logger.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../config/boot'
+
+module FacterStatistax
+  def self.logger
+    FileUtils.mkdir_p(LOG_DIR) unless Dir.exist?(LOG_DIR)
+
+    stdout_logger = Logger.new(STDOUT)
+    stdout_logger.level = Logger::DEBUG
+
+    @file_logger ||= Logger.new(::File.open(File.join(LOG_DIR, 'statistax.log'), 'a'))
+    @file_logger.level = Logger::DEBUG
+
+    @logger = Common::MultiLogger.new(@file_logger, stdout_logger)
+  end
+end

data/scripts/benchmark_script.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'benchmark'
+require 'open3'
+
+if ARGV[0].to_s == 'false'
+  if Gem.win_platform?
+    facter_dir = "C:/Program Files/Puppet Labs/Puppet/puppet/lib/ruby/vendor_ruby/../../../"
+    ENV['PATH'] = "#{File.join(facter_dir, 'bin')}#{File::PATH_SEPARATOR}#{File.join(facter_dir, '../puppet/bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+    require "#{facter_dir}/bin/libfacter.so"
+  else
+    require "/opt/puppetlabs/puppet/lib/libfacter.so"
+  end
+else
+  if Gem.win_platform?
+    require 'C:\Program Files\Puppet Labs\Puppet\puppet\lib\ruby\gems\2.5.0\gems\facter-2.5.5-x64-mingw32\lib\facter.rb'
+  else
+    require 'facter'
+  end
+end
+
+
+time = Benchmark.realtime do
+  if ARGV[1] == 'all'
+    Facter.to_hash
+  else
+    Facter.value(ARGV[1])
+  end
+end
+
+puts time
+
+

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: facter-statistax
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ''
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-08 00:00:00.000000000 Z
+dependencies:
+- !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: fileutils
+  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: rubysl-open3
+  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: json
+  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'
+description: Benchmark for facter
+email: ''
+executables:
+- statistax
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubycritic.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- bin/statistax
+- config/boot.rb
+- facter-statistax.gemspec
+- lib/common/multi_logger.rb
+- lib/common/output_writer.rb
+- lib/executors/executor.rb
+- lib/executors/test_run_executor.rb
+- lib/logger.rb
+- scripts/benchmark_script.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- 'Facter-Statistax '
+- "--main"
+- README
+- "--line-numbers"
+require_paths:
+- bin
+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: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Facter-Statistax, benchmark for facter
+test_files: []