hawatel_ps 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1eba24ecceee6ba4df134bed7e92d276ac3cc41
+  data.tar.gz: ba617239b79e504d611fab5bb0fb890f70c57afb
+SHA512:
+  metadata.gz: 1a5fee76376c92ea87024107aa7b9576ef805aa1d4dfe4b5de2e9f02f9876daeac06d61f16b496fb9b2663847f31236a94483d1ceb75bdf09c5465bf8b9979ef
+  data.tar.gz: 28b7794a040fa2b84a23733fa1e46063cd0274bbfa1c45b5b8bfe23f0c277e4d65f84c789ab9214e6ae2699ad12de17c8029bd44873e1fa4311d0aa39084a389

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+/coverage

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--profile

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/.yardopts

@@ -0,0 +1 @@
+--private

data/CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hawatel/hawatel_ps. This project is intended to be a safe, welcoming space for collaboration, and contributors.
+
+1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork,
+   and configure the remotes:
+
+   ```sh
+   # Clone your fork of the repo into the current directory
+   git clone https://github.com/<your-username>/hawatel_ps
+   # Navigate to the newly cloned directory
+   cd hawatel_ps
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream https://github.com/hawatel/hawatel_ps
+   ```
+
+2. If you cloned a while ago, get the latest changes from upstream:
+
+   ```bash
+   git checkout master
+   git pull upstream master
+   ```
+
+3. Create a new topic branch (off of `master`) to contain your feature, change,
+   or fix.
+
+   **IMPORTANT**: Making changes in `master` is discouraged. You should always
+   keep your local `master` in sync with upstream `master` and make your
+   changes in topic branches.
+
+   ```sh
+   git checkout -b <topic-branch-name>
+   ```
+
+4. Commit your changes in logical chunks. Keep your commit messages organized,
+   with a short description in the first line and more detailed information on
+   the following lines. Feel free to use Git's
+   [interactive rebase](https://help.github.com/articles/about-git-rebase/)
+   feature to tidy up your commits before making them public.
+
+5. Make sure all the tests are still passing.
+
+   ```sh
+   rspec spec/windows
+   ```
+   or
+   ```sh
+   rspec spec/linux
+   ```
+
+6. Push your topic branch up to your fork:
+
+   ```sh
+   git push origin <topic-branch-name>
+   ```
+
+7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
+    with a clear title and description.
+
+8. If you haven't updated your pull request for a while, you should consider
+   rebasing on master and resolving any conflicts.
+
+   **IMPORTANT**: _Never ever_ merge upstream `master` into your branches. You
+   should always `git rebase` on `master` to bring your changes up to date when
+   necessary.
+
+   ```sh
+   git checkout master
+   git pull upstream master
+   git checkout <your-topic-branch>
+   git rebase master
+   ```
+
+Thank you for your contributions!

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hawatel_ps.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Daniel Iwaniuk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,184 @@
+# HawatelPS
+
+## Summary
+**HawatelPS** (hawatel_ps) is a Ruby gem for retrieving information about **running processes**. It is easy to use, and you can get useful information about a process. You can `terminate`, `suspend`, `resume` and check the `status` of the process on Linux platform. On Windows platform, you can `terminate` and check the current `status` of the process.
+
+* On Linux platform, the HawatelPS collects all information from pseudo-file system /proc, and it is **free from any gem dependencies**.
+* On Windows platform the HawatelPS collects all information from WMI (Windows Management Instrumentation), and it is **free from any gem dependencies**.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hawatel_ps'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hawatel_ps
+
+## Example usage
+###### Find process with specified PID
+```ruby
+process = HawatelPS.search_by_pid(123)
+p process.name if !process.nil?
+```
+###### Get list all running processes
+```ruby
+processes = HawatelPS.proc_table
+```
+###### Find processes which matching a certain name
+``` ruby
+processes = HawatelPS.search_by_name('ruby')
+processes.each do |process|
+  p "PID: #{process.pid}"
+end
+```
+###### Find processes where vmsize attribute is equal or greater than 2000 kb
+```ruby
+processes = HawatelPS.search_by_condition(attr => 'vmsize', oper => '>=', value => '2000')
+processes.each do |process|
+  p process.pid
+end
+```
+###### Suspend processes which name matching with regular expression
+``` ruby
+processes = HawatelPS.search_by_name('/^ruby/')
+processes.each do |process|
+  p process.suspend
+end
+```
+###### Resume stopped processes
+``` ruby
+processes = HawatelPS.search_by_condition(attr => 'state', oper => '==', value => 'stopped')
+processes.each do |process|
+  p process.resume
+end
+```
+###### Terminate processes which using more that 60% CPU
+``` ruby
+processes = HawatelPS.search_by_condition(attr => 'cpu_percent', oper => '>', value => '60')
+processes.each do |process|
+  p process.terminate
+end
+```
+
+## Process attributes
+####  Linux 
+**NOTE:** In case lack of permission to retrieving specified information, the attribute should return a string with the message "Permission denied."
+
+| Attribute name        | Description  |
+| ------------- |-------------| 
+| cancelled_write_bytes | Cancelled write bytes. |
+| childs |Childs of the process.|
+| cmdline | Command line arguments. |
+| cpu_percent |  Average percent cpu usage since start. | 
+| cpu_time | Total cpu time. |
+| ctime | Create process time. |
+| cwd   | Current working directory. | 
+| egid  |  Effective GID. |
+| environ  | Environment of the process. |
+| euid | Effective UID. |
+| exe  | Filename of the executable.     |
+| fsgidl |  File system GID. |
+| fsuid |  File system UID. |
+| limits |  Limits |
+| listen_ports | List ports on which process listening. | 
+| memory_percent | Percent total memory usage by process. |
+| open_files | List open files by process (exclude /proc & /dev). |
+| pid        |  Process id.  |
+| ppid         | Process id of the parent process. |      
+| rchar |  Chars read. |
+| read_bytes | Bytes read. |
+| rgid  | Real GID. |
+| ruid | Real UID. |
+| sgid  | Saved set GID. |
+| state  | State of process (running, stopped, ….).      |
+| stime | Kernel mode jiffies. |
+| suid | Saved set UID. |
+| syscr |  Read syscalls (numer of read  I/O operations). | 
+| syscw | Write syscalls (numer of write I/O operations). |
+| threads  | Numer of threads. |
+| tty |  Controlling tty (terminal). |
+| username | The user name of the owner of this process. |
+| utime | User mode jiffies. |
+| vmdata | Size of private data segments. |
+| vmlib  | Size of shared library code. |
+| vmrss |  Size of memory portions. |
+| vmsize | Total program size. |
+| vmswap | Amount of swap used by process. |
+| wchar |  Chars written. |
+| write_bytes | Bytes written. |
+
+#### Windows
+
+|         Attribute name       |  Description  
+|-------------------------------|-------------
+availablevirtualsize           |The free virtual address space available to this process.        
+caption                        |Short description of an process one-line string.
+childs                         |Childs of the process.              
+commandline                    |Command line used to start a specific process, if applicable.
+cpupercent                     |Average percent cpu usage since process start.          
+creationclassname              |It is always Win32_Process
+creationdate                   |Date the process begins executing.               
+cscreationclassname            |It is always Win32_ComputerSystem.     
+csname                         |Name of the scoping computer system.               
+description                    |Description of a process.               
+domain                         |The domain name under which this process is running.               
+executablepath                 |Path to the executable file of the process.               
+executionstate                 |It is always nil.               
+handle                         |Process identifier.                  
+handlecount                    |Total number of open handles owned by the process. HandleCount is the sum of the handles currently open by each thread in this process.                
+installdate                    |Date an object is installed. The object may be installed without a value being written to this property.               
+kernelmodetime                 |Time in kernel mode, in 100 nanosecond units. If this information is not available, use a value of 0 (zero)              
+maximumworkingsetsize          |Maximum working set size of the process. The working set of a process is the set of memory pages visible to the process in physical RAM.                
+memorypercent                  |Average percent memory usage by the process (with shared memory, equivalent to WorkingSet in TaskManager)               
+minimumworkingsetsize          |Minimum working set size of the process. The working set of a process is the set of memory pages visible to the process in physical RAM.               
+name                           |Name of the executable file responsible for the process, equivalent to the Image Name property in Task Manager.               
+oscreationclassname            |It is always Win32_OperatingSystem.               
+osname                         |Name of the scoping operating system.               
+otheroperationcount            |Number of I/O operations performed that are not read or write operations.               
+othertransfercount             |Amount of data transferred during operations that are not read or write operations.               
+pagefaults                     |Number of page faults that a process generates.               
+pagefileusage                  |Amount of page file space that a process is using currently. This value is consistent with the VMSize value in TaskMgr.exe.               
+parentprocessid                |Unique identifier of the process that creates a process.               
+peakpagefileusage              |Maximum amount of page file space used during the life of a process.                  
+peakvirtualsize                |Maximum virtual address space a process uses at any one time. Using virtual address space does not necessarily imply corresponding use of either disk or main memory pages.               
+peakworkingsetsize             |Peak working set size of a process.               
+priority                       |Scheduling priority of a process within an operating system.               
+privatepagecount               |Current number of pages allocated that are only accessible to the process represented by this Win32_Process instance.               
+processid                      |Numeric identifier used to distinguish one process from another.               
+quotanonpagedpoolusage         |Quota amount of nonpaged pool usage for a process.               
+quotapagedpoolusage            |Quota amount of paged pool usage for a process.               
+quotapeaknonpagedpoolusage     |Peak quota amount of nonpaged pool usage for a process.               
+quotapeakpagedpoolusage        |Peak quota amount of paged pool usage for a process.               
+readoperationcount             |Number of read operations performed.               
+readtransfercount              |Amount of data read.               
+sessionid                      |Unique identifier that an operating system generates when a session is created. A session spans a period of time from logon until logoff from a specific system.               
+sid                            |The security identifier descriptor for the owner of this process.               
+status                         |State of a process ('running' or 'not running')             
+terminationdate                |Process was stopped or terminated. To get the termination time, a handle to the process must be held open. Otherwise, this property returns NULL.               
+threadcount                    |Number of active threads in a process.               
+user                           |The user name of the owner of this process.                  
+usermodetime                   |Time in user mode, in 100 nanosecond units. If this information is not available, use a value of 0 (zero).               
+virtualsize                    |Current size of the virtual address space that a process is using, not the physical or virtual memory actually used by the process.               
+windowsversion                 |Version of Windows in which the process is running.                  
+wmi_object                     |Native WMI Object represented by the process.               
+workingsetsize                 |Amount of memory in bytes that a process needs to execute efficiently—for an operating system that uses page-based memory management.               
+writeoperationcount            |Number of write operations performed.               
+writetransfercount             |Amount of data written.    
+
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md)
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+platform = 'windows' if RUBY_PLATFORM =~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+platform = 'linux'  if RUBY_PLATFORM =~ /linux/
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern    = FileList["spec/#{platform}/*/*_spec.rb"]
+  spec.rspec_opts = ['--color', '--format d']
+end
+
+task :default => :spec

data/hawatel_ps.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hawatel_ps/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hawatel_ps"
+  spec.version       = HawatelPs::VERSION
+  spec.authors       = ['Przemyslaw Mantaj','Daniel Iwaniuk']
+  spec.email         = ['przemyslaw.mantaj@hawatel.com', 'daniel.iwaniuk@hawatel.com']
+
+  spec.summary       = "Ruby gem for retrieving information about running processes"
+  spec.description   = %q{HawatelPS (hawatel_ps) is a Ruby gem for retrieving information about running processes. It is easy to use and you can get useful information about a process.
+                          You can terminate, suspend, resume and check status of the process on Linxu platform. On Windows platform you can terminate and check state of the process.}
+  spec.homepage      = "http://github.com/hawatel/hawatel_ps"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9'
+
+  spec.add_development_dependency "factory_girl"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/hawatel_ps/linux/proc_control.rb

@@ -0,0 +1,75 @@
+module HawatelPS
+  module Linux
+    class ProcControl
+
+      # Check current process status
+      # @example
+      #   p = HawatelPS.search_by_name('top')
+      #   p.status
+      #
+      # @return [String] - current process status (running, stopped ..)
+      def status
+        sleep(0.2)
+        status_file = "/proc/#{@proc_attrs[:pid]}/status"
+        if File.readable?(status_file)
+          File.foreach(status_file).each do |attr|
+            return attr.split(' ')[2].chop[1..-1] if attr =~ /State:/
+          end
+        end
+        'terminated'
+      end
+
+      # Suspend process without loss data (equal to Kill -SIGSTOP <pid> command)
+      #
+      # @example
+      #   p = HawatelPS.search_by_name('top')
+      #   p.suspend
+      #
+      # @return [String] - current process status (running, stopped ..)
+      def suspend
+        process_status = status
+        if process_status != 'terminated' && process_status != 'stopped'
+          return status if Process.kill('STOP', @proc_attrs[:pid].to_i)
+        end
+        process_status
+      rescue Errno::EPERM
+        return 'non-privilaged operation'
+      end
+
+      # Resume suspended process (equal to Kill -SIGCONT <pid> command)
+      #
+      # @example
+      #   p = HawatelPS.search_by_name('top')
+      #   p.resume
+      #
+      # @return [String] - current process status (running, stopped ..)
+      def resume
+        process_status = status
+        if process_status  == 'stopped'
+          return status if Process.kill('CONT', @proc_attrs[:pid].to_i)
+        end
+        process_status
+      rescue Errno::EPERM
+        return 'non-privilaged operation'
+      end
+
+      # Kill process (equal to Kill -SIGKILL <pid> command)
+      #
+      # @example
+      #   p = HawatelPS.search_by_name('top')
+      #   p.kill
+      #
+      # @return [String] - current process status (running, stopped ..)
+      def terminate
+        process_status = status
+        if process_status != 'terminated'
+          return status if Process.kill('KILL', @proc_attrs[:pid])
+        end
+        process_status
+      rescue Errno::EPERM
+        return 'non-privilaged operation'
+      end
+
+    end
+  end
+end