zephyr_cli 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d235f2f31b01aec14489f13000096529c298e779053339dc8e6f32a26acd9f3
-  data.tar.gz: fe2aaaed9d9f4c15f145fcba25519558c34481f27a80515fda5b436d23f0c7be
+  metadata.gz: a3c4194d263d8837a099c4307fd535c20b2423d1f170540e9bef95de9eef911f
+  data.tar.gz: 611479b3ca37be02b25e2438e7b5a5ba3562ed6ca5bc99f6a3d6edddeb3c2a69
 SHA512:
-  metadata.gz: f25848195ce2ecbd577d87fe45c7ee5524e73f46b30fb0c1bd5775052ed8768ba9c11c1cbef53ddaa4eaafd28f5bab5e0c933bd908fe261a01464fdc5102406e
-  data.tar.gz: 28832cc18969f149a87d6c888ea6016e00f79422b42b51b3634484da4608d37f9b24e1e396aee1f3f234180212746921d4626eeaed2f832fa783f5bc95227783
+  metadata.gz: 129e0a9dcd71d6fd5f5122604ec210386780e5128c01d5542c8c85c9a1bd1962b9bbf8dc82a7d3f2742e32349baa840856dc4194dbc0d54d24e7404451c7aff4
+  data.tar.gz: dd675f021111e9c1f1caa32086dc978160a9b5c0f8ff2794811343c9a813bb09f264c36d44c2a9f5093e1df516c751e660a6e35bf5d1822c681a2c9ba7d95f64

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/config

data/.rubocop.yml

@@ -8,3 +8,12 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics/ParameterLists:
+  Max: 10
+
+AllCops:
+  SuggestExtensions: false
+  TargetRubyVersion: 2.3
+  NewCops: disable
+

data/Gemfile

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'rake', '~> 13.0'
-gem 'rubocop', '~> 0.80'
-gem 'thor'
-gem 'zephyr_ruby'
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 0.80"
+gem "thor"
+gem "zephyr_ruby"

data/README.md

@@ -1,8 +1,6 @@
-# ZephyrCli
+# ZephyrCLI
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/zephyr_cli`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+The handy CLI for managing all your zephyr related testing resources.
 
 ## Installation
 
@@ -22,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+🚧 In progress. 
 
 ## Development
 

data/lib/zephyr_cli/helpers/cli_helpers.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# CLIHelpers module to share common methods among the CLI classes
+module CLIHelpers
+  def generate_automations_payload(project_id, file, _auto_close_cycle, name, description,
+                                   auto_create_test_cases: false)
+    auto_create_test_cases = true if auto_create_test_cases
+
+    {
+      projectKey: project_id,
+      autoCreateTestCases: auto_create_test_cases,
+      file: file,
+      testCycle: {
+        name: name,
+        description: description
+      }
+    }
+  end
+
+  def generate_test_cycle_payload(name, description, start_date, end_date, project_id)
+    {
+      name: name,
+      description: description,
+      plannedStartDate: start_date,
+      plannedEndDate: end_date,
+      projectId: project_id
+    }
+  end
+end

data/lib/zephyr_cli/test_cycles.rb

@@ -1,8 +1,51 @@
 # frozen_string_literal: true
 
+# Subcommand for creating and updating test cycles as well as uploading results in junit and cucumber format
 class TestCycles < Thor
-  desc "hello NAME", "say hello to NAME"
-  def hello(name)
-    puts "Hello #{name}"
+  desc "upload_junit_results", "Upload test results in junit format"
+  method_option :project_id, type: :numeric, required: true
+  method_option :file, type: :string, required: true
+  method_option :name, type: :string, required: true
+  method_option :description, type: :string, required: false
+  method_option :auto_create_test_cases, type: :boolean, required: false
+  def upload_junit_results(project_id, file, auto_close_cycle, name, description, auto_create_test_cases)
+    payload = generate_automations_payload(project_id, file, auto_close_cycle, name, description,
+                                           auto_create_test_cases)
+    @zephyr_client.create_automation_junit(payload)
+  end
+
+  desc "upload_cucumber_results", "Upload test results in cucumber format"
+  method_option :project_id, type: :numeric, required: true
+  method_option :file, type: :string, required: true
+  method_option :name, type: :string, required: true
+  method_option :description, type: :string, required: false
+  method_option :auto_create_test_cases, type: :boolean, required: false
+  def upload_cucumber_results(_test_cycle_id, _cucumber_format)
+    payload = generate_automations_payload(project_id, file, auto_close_cycle, name, description,
+                                           auto_create_test_cases)
+    @zephyr_client.create_automation_cucumber(payload)
+  end
+
+  desc "create", "Create test cycle"
+  method_option :project_id, type: :numeric, required: true
+  method_option :name, type: :string, required: true
+  method_option :description, type: :string, required: true
+  method_option :start_date, type: :string, required: true
+  method_option :end_date, type: :string, required: true
+  def create(name, description, start_date, end_date, project_id)
+    payload = generate_test_cycle_payload(name, description, start_date, end_date, project_id)
+    @zephyr_client.create_test_cycle(payload)
+  end
+
+  desc "update", "Update test cycle"
+  method_option :project_id, type: :numeric, required: true
+  method_option :test_cycle_id, type: :numeric, required: true
+  method_option :name, type: :string, required: true
+  method_option :description, type: :string, required: true
+  method_option :start_date, type: :string, required: true
+  method_option :end_date, type: :string, required: true
+  def update(_test_cycle_id, name, description, start_date, end_date, project_id)
+    payload = generate_test_cycle_payload(name, description, start_date, end_date, project_id)
+    @zephyr_client.update_test_cycle(payload)
   end
 end

data/lib/zephyr_cli/test_plans.rb

@@ -1,8 +1,25 @@
 # frozen_string_literal: true
 
+# Subcommand for creating and updating test plans
 class TestPlans < Thor
-  desc "hello NAME", "say hello to NAME"
-  def hello(name)
-    puts "Hello #{name}"
+  desc "create", "Create test plan"
+  method_option :name, type: :string, required: true
+  method_option :description, type: :string, required: true
+  method_option :start_date, type: :string, required: true
+  method_option :end_date, type: :string, required: true
+  method_option :project_id, type: :numeric, required: true
+  def create_test_plan(name, description, start_date, end_date, project_id)
+    # TODO: Implement logic for creating test plan
+  end
+
+  desc "update", "Update test plan"
+  method_option :test_plan_id, type: :numeric, required: true
+  method_option :name, type: :string, required: true
+  method_option :description, type: :string, required: true
+  method_option :start_date, type: :string, required: true
+  method_option :end_date, type: :string, required: true
+  method_option :project_id, type: :numeric, required: true
+  def update_test_plan(test_plan_id, name, description, start_date, end_date, project_id)
+    # TODO: Implement logic for updating test plan
   end
 end

data/lib/zephyr_cli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module ZephyrCli
-  VERSION = "0.1.0"
+module ZephyrCLI
+  VERSION = "0.1.1"
 end

data/lib/zephyr_cli.rb

@@ -1,14 +1,22 @@
 # frozen_string_literal: true
 
+require "zephyr_ruby"
+require "thor"
+require "nokogiri"
 require_relative "zephyr_cli/version"
+require_relative "zephyr_cli/test_cycles"
+require_relative "zephyr_cli/test_plans"
+require_relative "zephyr_cli/helpers/cli_helpers"
 
-module ZephyrCli
-  class Error < StandardError; end
+@zephyr_client = ZephyrRuby::Client.new(ENV["ZEPHYR_API_KEY"])
 
-  class MyCLI < Thor
-    desc "hello NAME", "say hello to NAME"
-    def hello(name)
-      puts "Hello #{name}"
-    end
-  end
+# CLI for creating test cycles and test plans in zephyr
+class CLI < Thor
+  desc "test_cycles", "Test cycles commands"
+  subcommand "test_cycles", TestCycles
+
+  desc "test_plans", "Test plans commands"
+  subcommand "test_plans", TestPlans
 end
+
+CLI.start(ARGV)

data/zephyr_cli.gemspec

@@ -4,7 +4,7 @@ require_relative "lib/zephyr_cli/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "zephyr_cli"
-  spec.version       = ZephyrCli::VERSION
+  spec.version       = ZephyrCLI::VERSION
   spec.authors       = ["Chris Davis"]
 
   spec.summary       = "Zephyr CLI"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zephyr_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Chris Davis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-26 00:00:00.000000000 Z
+date: 2024-08-03 00:00:00.000000000 Z
 dependencies: []
 description: Zephyr CLI
 email:
@@ -26,11 +26,11 @@ files:
 - bin/console
 - bin/setup
 - lib/zephyr_cli.rb
-- lib/zephyr_cli/helpers/zephyr_client.rb
-- lib/zephyr_cli/test_cases.rb
+- lib/zephyr_cli/helpers/cli_helpers.rb
 - lib/zephyr_cli/test_cycles.rb
 - lib/zephyr_cli/test_plans.rb
 - lib/zephyr_cli/version.rb
+- zephyr_cli-0.1.0.gem
 - zephyr_cli.gemspec
 homepage: https://github.com/cdavis-personal/zephyr_cli
 licenses: []

data/lib/zephyr_cli/helpers/zephyr_client.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require "zephyr_ruby"
-
-module ZephyrClient
-  @client = ZephyrRuby::Client.new("YOUR_API_KEY")
-end

data/lib/zephyr_cli/test_cases.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-class TestCases < Thor
-  desc "hello NAME", "say hello to NAME"
-  def hello(name)
-    puts "Hello #{name}"
-  end
-end