makit 0.0.1 → 0.0.3

data/docs_/Minitest.Timeouts.md

@@ -1,332 +0,0 @@
-### **Setting Timeouts on Minitest Tests**
-
-To ensure that your tests do not run indefinitely or take too long, you can set timeouts on your Minitest tests. This is particularly useful for catching hanging tests or identifying performance issues.
-
-There are several ways to set timeouts in Minitest:
-
-1. **Using Ruby's `Timeout` Module**
-2. **Using the `minitest-timeout` Gem**
-3. **Using Custom Assertions**
-
----
-
-#### **1. Using Ruby's `Timeout` Module**
-
-The standard Ruby library provides a `Timeout` module that can be used to limit the execution time of code blocks.
-
-**Example:**
-
-```ruby
-require 'minitest/autorun'
-require 'timeout'
-
-class MyTest < Minitest::Test
-  def test_with_timeout
-    Timeout.timeout(5) do
-      # Test code that should complete within 5 seconds
-      long_running_operation
-    end
-  rescue Timeout::Error
-    flunk "Test exceeded time limit and was aborted."
-  end
-
-  private
-
-  def long_running_operation
-    sleep 10 # Simulates a long-running operation
-  end
-end
-```
-
-**Explanation:**
-
-- **`Timeout.timeout(5) do ... end`**: Executes the block and raises a `Timeout::Error` if it takes more than 5 seconds.
-- **Rescuing `Timeout::Error`**: Captures the timeout exception and marks the test as failed using `flunk`.
-
-**Caveats:**
-
-- The `Timeout` module uses threads to interrupt the execution, which can be unsafe for certain operations, especially IO operations or code that is not thread-safe.
-- Using `Timeout` can sometimes lead to unexpected behavior or hard-to-debug issues due to the abrupt interruption.
-
----
-
-#### **2. Using the `minitest-timeout` Gem**
-
-The `minitest-timeout` gem provides a cleaner and safer way to set timeouts on tests.
-
-**Installation:**
-
-Add the gem to your `Gemfile`:
-
-```ruby
-gem 'minitest-timeout'
-```
-
-Then run:
-
-```bash
-bundle install
-```
-
-**Usage:**
-
-```ruby
-# test/test_helper.rb
-
-require 'minitest/autorun'
-require 'minitest/timeout'
-
-# Set a default timeout for all tests (optional)
-Minitest::Timeout.timeout = 5 # seconds
-```
-
-```ruby
-# test/my_test.rb
-
-require_relative 'test_helper'
-
-class MyTest < Minitest::Test
-  timeout 5 # seconds
-
-  def test_long_running_operation
-    # This test will fail if it runs longer than 5 seconds
-    long_running_operation
-  end
-
-  def test_another_operation
-    # Override timeout for a specific test
-    timeout(2)
-    another_long_running_operation
-  end
-
-  private
-
-  def long_running_operation
-    sleep 10
-  end
-
-  def another_long_running_operation
-    sleep 3
-  end
-end
-```
-
-**Explanation:**
-
-- **`timeout 5` at the class level**: Sets a default timeout of 5 seconds for all tests in the class.
-- **`timeout(2)` in a test method**: Overrides the timeout for that specific test.
-- **Global Timeout**: You can set a global timeout in the `test_helper.rb` that applies to all tests.
-
-**Benefits:**
-
-- **Safe Execution**: The gem ensures that the timeout is handled safely without the drawbacks of the `Timeout` module.
-- **Easy Configuration**: Allows setting timeouts at the test, class, or global level.
-- **Consistent Behavior**: Provides consistent behavior across different types of tests.
-
----
-
-#### **3. Using Custom Assertions**
-
-You can create a custom assertion to check the execution time of your tests.
-
-**Example:**
-
-```ruby
-require 'minitest/autorun'
-
-class MyTest < Minitest::Test
-  def test_with_custom_timeout
-    assert_execution_time 5 do
-      long_running_operation
-    end
-  end
-
-  private
-
-  def assert_execution_time(max_seconds, &block)
-    start_time = Time.now
-    yield
-    end_time = Time.now
-    execution_time = end_time - start_time
-    assert execution_time <= max_seconds, "Expected execution time to be less than #{max_seconds}s, but was #{execution_time.round(2)}s"
-  end
-
-  def long_running_operation
-    sleep 10
-  end
-end
-```
-
-**Explanation:**
-
-- **`assert_execution_time`**: A custom assertion method that measures the time taken to execute a block.
-- **Usage**: Wrap the code you want to time within the `assert_execution_time` block.
-- **Assertion**: Fails the test if the execution time exceeds the specified maximum.
-
-**Caveats:**
-
-- This method doesn't interrupt the test if it exceeds the time limit; it only checks after the fact.
-- Not suitable if you need to abort the test execution upon exceeding the time limit.
-
----
-
-### **Recommendations**
-
-For most use cases, using the `minitest-timeout` gem is the most effective and safest way to set timeouts on your Minitest tests.
-
----
-
-### **Implementing Timeouts in Your Task**
-
-Given your existing test setup, here's how you might integrate timeouts.
-
-**Step 1: Install `minitest-timeout` Gem**
-
-Add to your `Gemfile`:
-
-```ruby
-gem 'minitest-timeout'
-```
-
-Run:
-
-```bash
-bundle install
-```
-
-**Step 2: Configure Timeout in `test_helper.rb`**
-
-Create or update your `test_helper.rb`:
-
-```ruby
-# test/test_helper.rb
-
-require 'minitest/autorun'
-require 'minitest/timeout'
-
-# Set a global timeout for all tests (e.g., 10 seconds)
-Minitest::Timeout.timeout = 10
-```
-
-**Step 3: Update Your Tests**
-
-In your test files, you can set timeouts as needed.
-
-```ruby
-require_relative 'test_helper'
-
-class WixTest < Minitest::Test
-  # Set a class-level timeout (overrides global timeout)
-  timeout 15
-
-  def test_setup_package
-    # Individual test code
-  end
-
-  def test_another_method
-    # Override timeout for this test
-    timeout(5)
-    # Test code
-  end
-end
-```
-
-**Step 4: Run Your Tests**
-
-Run your tests as usual, and they will fail if any test exceeds the specified timeout.
-
----
-
-### **Handling Timeout Failures**
-
-When a test exceeds the timeout, it will fail with a message indicating that the execution time was exceeded.
-
-**Example Failure Message:**
-
-```
-Minitest::Timeout::Error: execution of test took longer than 5 seconds.
-```
-
-You can handle or customize this behavior if needed.
-
----
-
-### **Caveats and Considerations**
-
-- **Long-Running Setup or Teardown:** If you have setup or teardown methods that might exceed the timeout, consider adjusting the timeout or refactoring the setup code.
-- **Thread Safety:** Ensure that your code is thread-safe, especially when using gems that manage timeouts internally.
-- **Debugging Timeouts:** If tests fail due to timeouts, investigate whether the code under test is inefficient, has infinite loops, or is waiting on external resources.
-
----
-
-### **Alternative Approaches**
-
-If you prefer not to use external gems, or if you need more control over the timeout behavior, consider the following:
-
-#### **Using `Timeout` Module with Care**
-
-While the `Timeout` module can be problematic, it may be acceptable for simple tests.
-
-**Example:**
-
-```ruby
-def test_with_timeout
-  status = :passed
-  begin
-    Timeout.timeout(5) do
-      long_running_operation
-    end
-  rescue Timeout::Error
-    status = :failed
-  end
-  assert_equal :passed, status, "Test exceeded time limit and was aborted."
-end
-```
-
-#### **Process Forking**
-
-For tests that may hang due to external resources or blocking IO, running tests in separate processes can prevent them from affecting the main test suite.
-
-**Example:**
-
-```ruby
-def test_with_fork_and_timeout
-  pid = fork do
-    long_running_operation
-  end
-  begin
-    Timeout.timeout(5) do
-      Process.wait(pid)
-    end
-  rescue Timeout::Error
-    Process.kill('TERM', pid)
-    flunk "Test exceeded time limit and was aborted."
-  end
-end
-```
-
-**Note:** Process forking is not available on Windows platforms.
-
----
-
-### **Conclusion**
-
-Setting timeouts on your Minitest tests helps ensure that they complete within expected time frames and aids in identifying performance issues or hanging tests. By using the `minitest-timeout` gem, you can easily integrate timeouts into your existing test suite with minimal changes.
-
----
-
-### **References**
-
-- [minitest-timeout GitHub Repository](https://github.com/kamui/minitest-timeout)
-- [Ruby Timeout Module Documentation](https://ruby-doc.org/stdlib-2.7.0/libdoc/timeout/rdoc/Timeout.html)
-- [Minitest Documentation](https://github.com/seattlerb/minitest)
-
----
-
-### **Additional Tips**
-
-- **Monitoring Test Performance:** Regularly monitor your test suite's performance to catch any tests that are consistently close to the timeout limit.
-- **CI/CD Integration:** Ensure that timeouts are appropriately set in continuous integration environments, where resources may differ from local development machines.
-- **Adjusting Timeouts:** Be cautious not to set timeouts too low, which could cause false negatives due to variations in execution time.
-
-By implementing timeouts effectively, you enhance the reliability and efficiency of your test suite.

data/examples/protoc/Rakefile

@@ -1,31 +0,0 @@
-require_relative "../../lib/makit"
-#require "makit"
-
-task :setup do
-  # setup the protoc environment
-  Makit::Protoc::setup
-
-  # copy the makit.v1.proto file to the current directory
-  FileUtils.cp(File.join("../../lib/makit/v1", "makit.v1.proto"), ".")
-
-  # create the artifacts directory
-  FileUtils.mkdir_p("artifacts") unless Dir.exist?("artifacts")
-end
-
-task :generate => [:setup] do
-  puts ":generate".colorize(:blue)
-
-  puts "  generating code from makit.v1.proto".colorize(:green)
-  "protoc -I . --ruby_out=artifacts makit.v1.proto".run
-  #"grpc_tools_ruby_protoc -I . --ruby_out=artifacts --grpc_out=artifacts makit.v1.proto".run
-end
-
-task :test do
-  runner = Makit::CommandRunner.new
-  command = runner.run(runner.parse_command_request("git --version"))
-
-  puts "command type: #{command.class}"
-  puts "command proto name: #{command.name}"
-end
-
-task :default => [:setup, :generate]

data/examples/rake_default/Rakefile

@@ -1,6 +0,0 @@
-require "makit"
-
-task :default do
-  puts "default task"
-  Makit::PROJECT.save_as(".makit.project.json") unless File.exist?(".makit.project.json")
-end

data/examples/rubygem-foo/Rakefile

@@ -1,3 +0,0 @@
-require_relative "../../lib/makit"
-
-task :default

data/examples/run_mp/Rakefile

@@ -1,8 +0,0 @@
-require "makit"
-
-task :default do
-  "git --version".run
-  "bogus --version".run({ exit_on_error: false })
-  "docker --version".run({ exit_on_error: false })
-  "makit --version".run({ exit_on_error: false })
-end

data/exe/makit

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "makit"
-Makit::Cli::MainCommand.run(ARGV)

data/lib/makit/content/default_gitignore.txt

@@ -1,222 +0,0 @@
-# General
-[Aa]rtifacts/
-[Ii]ntermediate/
-[Gg]enerated/
-third_party/
-
-# Ruby
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-.rvmrc
-
-# Rust
-/target/
-Cargo.lock
-**/*.rs.bk
-/target
-/Cargo.lock
-
-# DotNet
-*.rsuser
-*.suo
-*.user
-*.userosscache
-*.sln.docstates
-*.txt
-*.userprefs
-BenchmarkDotNet.Artifacts/
-[Dd]ebug/
-[Dd]ebugPublic/
-[Rr]elease/
-[Rr]eleases/
-x64/
-x86/
-[Aa][Rr][Mm]/
-[Aa][Rr][Mm]64/
-bld/
-[Bb]in/
-[Oo]bj/
-[Ll]og/
-[Aa]rtifacts/
-.vs/
-Generated\ Files/
-[Tt]est[Rr]esult*/
-[Bb]uild[Ll]og.*
-*.VisualState.xml
-TestResult.xml
-[Dd]ebugPS/
-[Rr]eleasePS/
-dlldata.c
-BenchmarkDotNet.Artifacts/
-
-project.lock.json
-project.fragment.lock.json
-artifacts/
-StyleCopReport.xml
-*_i.c
-*_p.c
-*_h.h
-*.ilk
-*.meta
-*.obj
-*.iobj
-*.pch
-*.pdb
-*.ipdb
-*.pgc
-*.pgd
-*.rsp
-*.sbr
-*.tlb
-*.tli
-*.tlh
-*.tmp
-*.tmp_proj
-*_wpftmp.csproj
-*.log
-*.vspscc
-*.vssscc
-.builds
-*.pidb
-*.svclog
-*.scc
-_Chutzpah*
-ipch/
-*.aps
-*.ncb
-*.opendb
-*.opensdf
-*.sdf
-*.cachefile
-*.VC.db
-*.VC.VC.opendb
-*.psess
-*.vsp
-*.vspx
-*.sap
-*.e2e
-$tf/
-*.gpState
-_ReSharper*/
-*.[Rr]e[Ss]harper
-*.DotSettings.user
-.JustCode
-_TeamCity*
-*.dotCover
-.axoCover/*
-!.axoCover/settings.json
-*.coverage
-*.coveragexml
-_NCrunch_*
-.*crunch*.local.xml
-nCrunchTemp_*
-*.mm.*
-AutoTest.Net/
-.sass-cache/
-[Ee]xpress/
-DocProject/buildhelp/
-DocProject/Help/*.HxT
-DocProject/Help/*.HxC
-DocProject/Help/*.hhc
-DocProject/Help/*.hhk
-DocProject/Help/*.hhp
-DocProject/Help/Html2
-DocProject/Help/html
-publish/
-*.[Pp]ublish.xml
-*.azurePubxml
-*.pubxml
-*.publishproj
-PublishScripts/
-*.nupkg
-**/[Pp]ackages/*
-!**/[Pp]ackages/build/
-*.nuget.props
-*.nuget.targets
-csx/
-*.build.csdef
-ecf/
-rcf/
-AppPackages/
-BundleArtifacts/
-Package.StoreAssociation.xml
-_pkginfo.txt
-*.appx
-*.[Cc]ache
-# but keep track of directories ending in .cache
-!*.[Cc]ache/
-ClientBin/
-~$*
-*~
-*.dbmdl
-*.dbproj.schemaview
-*.jfm
-*.pfx
-*.publishsettings
-orleans.codegen.cs
-**/wwwroot/lib/
-Generated_Code/
-_UpgradeReport_Files/
-Backup*/
-UpgradeLog*.XML
-UpgradeLog*.htm
-ServiceFabricBackup/
-*.rptproj.bak
-*.mdf
-*.ldf
-*.ndf
-*.rdl.data
-*.bim.layout
-*.bim_*.settings
-*.rptproj.rsuser
-FakesAssemblies/
-*.GhostDoc.xml
-.ntvs_analysis.dat
-node_modules/
-*.plg
-*.opt
-*.vbw
-**/*.HTMLClient/GeneratedArtifacts
-**/*.DesktopClient/GeneratedArtifacts
-**/*.DesktopClient/ModelManifest.xml
-**/*.Server/GeneratedArtifacts
-**/*.Server/ModelManifest.xml
-_Pvt_Extensions
-.paket/paket.exe
-paket-files/
-.fake/
-.idea/
-*.sln.iml
-.cr/personal
-__pycache__/
-*.pyc
-tools/**
-!tools/packages.config
-*.tss
-*.jmconfig
-*.btp.cs
-*.btm.cs
-*.odx.cs
-*.xsd.cs
-OpenCover/
-ASALocalRun/
-*.binlog
-*.nvuser
-.mfractor/
-.localhistory/

data/lib/makit/content/ruby_gitlab-ci.yml

@@ -1,15 +0,0 @@
-image: image: ruby:3.2.3
-
-before_script:
-    - pwd
-    - git --version
-    - ruby --version
-    - gem install rake bundler
-    - rake --version
-    - gem install bundler -v 2.5.10
-    - bundle install
-
-example_job:
-  script:
-    - ruby -r minitest/autorun test/test_makit.rb
-    - bundle exec rake