win32-taskscheduler 2.0.1 → 2.0.4

data/spec/spec_helper.rb

@@ -1,224 +0,0 @@
-libx = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(libx) unless $LOAD_PATH.include?(libx)
-
-require 'date'
-
-# In order to test some dummy task and folder, we are creating
-# 'Test' folder and consider it as 'root'.
-# After the test case, all the above created elements
-# i.e, 'Test', Tasks and nested folders will be deleted.
-# It will ensure No Harm be caused to any existing tasks at root
-
-# Creating folder 'Test'; This will be treated as root
-def create_test_folder
-  @service ||= service
-  @root_path = '\\'
-  @test_path = '\\Test'
-  @root_folder = @service.GetFolder(@root_path)
-  @test_folder = @root_folder.CreateFolder(@test_path)
-  @ts.instance_variable_set(:@root, @test_folder) if @ts
-end
-
-# Deleting the test folder its nested folder(if any)
-# And the tasks within(if any)
-def clear_them
-  if @test_folder
-    delete_all(@test_folder)
-  else
-    @test_folder = nil
-  end
-end
-
-# Logic to delete tasks and folder using Win32OLE methods
-def delete_all(folder)
-  delete_tasks_in(folder)
-  folder.GetFolders(0).each do |nested_folder|
-    delete_all(nested_folder)
-  end
-  @root_folder.DeleteFolder(folder.Path, 0)
-end
-
-# Deleting the task in specified folder using Win32OLE methods
-def delete_tasks_in(folder)
-  folder.GetTasks(0).each do |task|
-    folder.DeleteTask(task.Name, 0)
-  end
-end
-
-# Returns Win32 Service object
-def service
-  service = WIN32OLE.new('Schedule.Service')
-  service.Connect
-  service
-end
-
-# Returns no of task in the specified folder
-def no_of_tasks(folder = @test_folder)
-  if folder.is_a?(String)
-    folder = @test_path + folder
-    folder = @service.GetFolder(folder)
-  end
-  folder.GetTasks(0).Count
-end
-
-# Steps to create (Register) a task
-# This is an example activity to test
-# the related functionalities over a task in RSpecs
-def create_task
-  return nil unless @service
-  @task_definition = @service.NewTask(0)
-  task_registration
-  task_prinicipals
-  task_settings
-  task_triggers
-  task_action
-  register_task
-end
-
-def task_registration
-  reg_info = @task_definition.RegistrationInfo
-  reg_info.Description = 'Sample task for testing purpose'
-  reg_info.Author = 'Rspec'
-end
-
-def task_prinicipals
-  principal = @task_definition.Principal
-  principal.LogonType = 3 # Interactive Logon
-end
-
-def task_settings
-  settings = @task_definition.Settings
-  settings.Enabled = true
-  settings.StartWhenAvailable = true
-  settings.Hidden = false
-end
-
-def task_triggers
-  triggers = @task_definition.Triggers
-  trigger = triggers.Create(1) # Time
-  start_time, end_time = start_end_time
-  trigger.StartBoundary = start_time
-  trigger.EndBoundary = end_time
-  trigger.ExecutionTimeLimit = 'PT5M' # Five minutes
-  trigger.Id = 'TimeTriggerId'
-  trigger.Enabled = true
-end
-
-def task_action
-  action = @task_definition.Actions.Create(0)
-  action.Path = @app
-end
-
-# Registering(Creating) a task in test folder
-def register_task
-  @current_task = @test_folder.RegisterTaskDefinition(
-    @task, # Name of the task
-    @task_definition, # Definition
-    6, # Flag: TASK_CREATE_OR_UPDATE
-    nil, # UserId
-    nil, # Password
-    3
-  )
-  @ts.instance_variable_set(:@task, @current_task) if @ts
-end
-
-def start_end_time
-  t = Date.new(2010)
-  start_time = t.strftime('%FT%T')
-  end_time = (t + 5).strftime('%FT%T') # 5 Days
-  [start_time, end_time]
-end
-
-def tasksch_err
-  Win32::TaskScheduler::Error
-end
-
-# Methods to build all types of triggers and their values
-
-def all_triggers
-  all_triggers = {}
-
-  %w[ONCE DAILY WEEKLY MONTHLYDATE MONTHLYDOW
-     ON_IDLE AT_SYSTEMSTART AT_LOGON].each do |trig_type|
-    trigger = {}
-    trigger[:trigger_type] = Win32::TaskScheduler.class_eval(trig_type)
-    start_end_params(trigger)
-    other_trigger_params(trig_type, trigger)
-    all_triggers[trig_type] = trigger
-  end
-
-  all_triggers
-end
-
-def start_end_params(trigger)
-  %i[start_year end_year].each do |t|
-    trigger[t] = '2030'
-  end
-
-  %i[start_month start_day start_hour start_minute].each do |t|
-    trigger[t] = '02'
-  end
-
-  %i[end_day end_month].each do |t|
-    trigger[t] = '03'
-  end
-
-  %i[minutes_duration minutes_interval].each do |t|
-    trigger[t] = 2
-  end
-end
-
-def other_trigger_params(trig_type, trigger)
-  type = {}
-  case trig_type
-  when 'ONCE'
-    trigger[:type] = type
-    type[:once] = nil
-    trigger[:random_minutes_interval] = 2
-  when 'DAILY'
-    trigger[:type] = type
-    type[:days_interval] = 2
-    trigger[:random_minutes_interval] = 2
-  when 'WEEKLY'
-    trigger[:type] = type
-    type[:weeks_interval] = 2
-    type[:days_of_week] = sunday
-    trigger[:random_minutes_interval] = 2
-  when 'MONTHLYDATE'
-    trigger[:type] = type
-    type[:months] = january
-    type[:days] = first_day
-    trigger[:run_on_last_day_of_month] = false
-    trigger[:random_minutes_interval] = 2
-  when 'MONTHLYDOW'
-    trigger[:type] = type
-    type[:months] = january
-    type[:days_of_week] = sunday
-    type[:weeks_of_month] = first_week
-    trigger[:run_on_last_week_of_month] = false
-    trigger[:random_minutes_interval] = 2
-  when 'ON_IDLE'
-    trigger[:execution_time_limit] = 2
-  when 'AT_SYSTEMSTART'
-    trigger[:delay_duration] = 2
-  when 'AT_LOGON'
-    trigger[:user_id] = 'SYSTEM'
-    trigger[:delay_duration] = 2
-  end
-end
-
-def sunday
-  Win32::TaskScheduler::SUNDAY
-end
-
-def january
-  Win32::TaskScheduler::JANUARY
-end
-
-def first_day
-  Win32::TaskScheduler::FIRST
-end
-
-def first_week
-  Win32::TaskScheduler::FIRST_WEEK
-end

data/spec/unit/win32/taskscheduler/constants_spec.rb

@@ -1,20 +0,0 @@
-require 'spec_helper'
-require 'win32/taskscheduler'
-require 'win32/taskscheduler/constants'
-
-RSpec.describe Win32::TaskScheduler, :windows_only do
-  describe 'Ensuring trigger constants' do
-    subject(:ts) { Win32::TaskScheduler }
-    describe 'to handle scheduled tasks' do
-      [:ONCE, :DAILY, :WEEKLY, :MONTHLYDATE, :MONTHLYDOW].each do |const|
-        it { should be_const_defined(const) }
-      end
-    end
-
-    describe 'to handle other types' do
-      [:AT_LOGON, :AT_SYSTEMSTART, :ON_IDLE].each do |const|
-        it { should be_const_defined(const) }
-      end
-    end
-  end
-end

data/spec/unit/win32/taskscheduler/time_calc_helper_spec.rb

@@ -1,217 +0,0 @@
-require 'spec_helper'
-require 'win32/taskscheduler/time_calc_helper'
-
-RSpec.describe Win32::TaskScheduler::TimeCalcHelper do
-  let(:object) { klass.new }
-  let(:klass) do
-    Class.new do
-      include Win32::TaskScheduler::TimeCalcHelper
-    end
-  end
-
-  describe '#is_leap_year?' do
-    it 'require an year in integer format' do
-      expect { object.is_leap_year? }.to raise_error(ArgumentError)
-      expect { object.is_leap_year?('year') }.to raise_error(NoMethodError)
-    end
-
-    it 'returns true for leap years' do
-      year = 2000
-      expect(object.is_leap_year?(year)).to be_truthy
-      year = 2004
-      expect(object.is_leap_year?(year)).to be_truthy
-    end
-
-    it 'returns false for non-leap years' do
-      year = 1900
-      expect(object.is_leap_year?(year)).to be_falsy
-      year = 2001
-      expect(object.is_leap_year?(year)).to be_falsy
-    end
-  end
-
-  describe '#days_in_month' do
-    it 'require month and year in integer format' do
-      expect { object.days_in_month }.to raise_error(ArgumentError)
-      expect { object.days_in_month('month', 'year') }.to raise_error(TypeError)
-    end
-
-    context 'leap year' do
-      year = 2000
-      it 'January will have 31 days' do
-        month = 1
-        expect(object.days_in_month(month, year)).to eql(31)
-      end
-
-      it 'February will have 29 days' do
-        month = 2
-        expect(object.days_in_month(month, year)).to eql(29)
-      end
-
-      it 'November will have 30 days' do
-        month = 11
-        expect(object.days_in_month(month, year)).to eql(30)
-      end
-    end
-
-    context 'non-leap year' do
-      year = 2003
-      it 'January will have 31 days' do
-        month = 1
-        expect(object.days_in_month(month, year)).to eql(31)
-      end
-
-      it 'February will have 28 days' do
-        month = 2
-        expect(object.days_in_month(month, year)).to eql(28)
-      end
-
-      it 'November will have 30 days' do
-        month = 11
-        expect(object.days_in_month(month, year)).to eql(30)
-      end
-    end
-  end
-
-  describe '#time_details' do
-    it 'require a time string in String format' do
-      expect { object.time_details }.to raise_error(ArgumentError)
-      expect { object.time_details(1234) }.to raise_error(TypeError)
-    end
-
-    it 'returns an empty hash if no string is passed' do
-      expect(object.time_details(nil)).to be_a(Hash)
-      expect(object.time_details(nil)).to be_empty
-    end
-
-    context 'of MSDN time string' do
-      it 'returns hash with date' do
-        time_str = 'P10Y10M10D'
-        time_hsh = { year: '10', month: '10', day: '10' }
-        expect(object.time_details(time_str)).to eq(time_hsh)
-      end
-
-      it 'returns hash with time' do
-        time_str = 'PT10H10M10S'
-        time_hsh = { hour: '10', min: '10', sec: '10' }
-        expect(object.time_details(time_str)).to eq(time_hsh)
-      end
-
-      it 'returns hash with date-time' do
-        time_str = 'P10Y10M10DT10H10M10S'
-        time_hsh = { year: '10', month: '10', day: '10',
-                     hour: '10', min: '10', sec: '10' }
-        expect(object.time_details(time_str)).to eq(time_hsh)
-      end
-    end
-  end
-
-  describe '#time_in_seconds' do
-    it 'require a time string in String format' do
-      expect { object.time_in_seconds }.to raise_error(ArgumentError)
-      expect { object.time_in_seconds(1234) }.to raise_error(TypeError)
-    end
-
-    it 'returns zero if no string is passed' do
-      expect(object.time_in_seconds(nil)).to be_zero
-    end
-
-    context 'in leap year' do
-      before do
-        time_now = Time.new(2004)
-        allow(Time).to receive(:now).and_return(time_now)
-      end
-
-      it 'returns seconds for date' do
-        time_str = 'P10Y10M10D'
-        expect(object.time_in_seconds(time_str)).to eq(342_748_800)
-      end
-
-      it 'returns seconds for time' do
-        time_str = 'PT10H10M10S'
-        expect(object.time_in_seconds(time_str)).to eq(36_610)
-      end
-
-      it 'returns seconds for date-time' do
-        time_str = 'P10Y10M10DT10H10M10S'
-        expect(object.time_in_seconds(time_str)).to eq(342_785_410)
-      end
-    end
-    context 'in non-leap year' do
-      before do
-        time_now = Time.new(2003)
-        allow(Time).to receive(:now).and_return(time_now)
-      end
-
-      it 'returns seconds for date' do
-        time_str = 'P10Y10M10D'
-        expect(object.time_in_seconds(time_str)).to eq(342_748_800)
-      end
-
-      it 'returns seconds for time' do
-        time_str = 'PT10H10M10S'
-        expect(object.time_in_seconds(time_str)).to eq(36_610)
-      end
-
-      it 'returns seconds for date-time' do
-        time_str = 'P10Y10M10DT10H10M10S'
-        expect(object.time_in_seconds(time_str)).to eq(342_785_410)
-      end
-    end
-  end
-
-  describe '#time_in_minutes' do
-    it 'require a time string in String format' do
-      expect { object.time_in_minutes }.to raise_error(ArgumentError)
-      expect { object.time_in_minutes(1234) }.to raise_error(TypeError)
-    end
-
-    it 'returns zero if no string is passed' do
-      expect(object.time_in_minutes(nil)).to be_zero
-    end
-
-    context 'in leap year' do
-      before do
-        time_now = Time.new(2004)
-        allow(Time).to receive(:now).and_return(time_now)
-      end
-
-      it 'returns minutes for date' do
-        time_str = 'P10Y10M10D'
-        expect(object.time_in_minutes(time_str)).to eq(5_712_480)
-      end
-
-      it 'returns minutes for time' do
-        time_str = 'PT10H10M10S'
-        expect(object.time_in_minutes(time_str)).to eq(610)
-      end
-
-      it 'returns minutes for date-time' do
-        time_str = 'P10Y10M10DT10H10M10S'
-        expect(object.time_in_minutes(time_str)).to eq(5_713_090)
-      end
-    end
-
-    context 'in non-leap year' do
-      before do
-        time_now = Time.new(2003)
-        allow(Time).to receive(:now).and_return(time_now)
-      end
-
-      it 'returns minutes for date' do
-        time_str = 'P10Y10M10D'
-        expect(object.time_in_minutes(time_str)).to eq(5_712_480)
-      end
-
-      it 'returns minutes for time' do
-        time_str = 'PT10H10M10S'
-        expect(object.time_in_minutes(time_str)).to eq(610)
-      end
-
-      it 'returns minutes for date-time' do
-        time_str = 'P10Y10M10DT10H10M10S'
-        expect(object.time_in_minutes(time_str)).to eq(5_713_090)
-      end
-    end
-  end
-end