fog-proxmox 0.10.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b70163a7fccb9ed54779d18ca8dc37d6ea04fec9ab2c94c91d13282feb589c6
-  data.tar.gz: 65b66339365af13f176e4cd4410f58bd9fa46c10c45082852b36bb5beaa4332b
+  metadata.gz: 2e153a5fb10f314d09cc54eec5e8b2a6733120fe5c82ab6a809f203d2211fbfa
+  data.tar.gz: 7f2aa37e3830abb05c6717dc3f9e1705bfb8aebfa6cf52b2726a81a430ce1ac9
 SHA512:
-  metadata.gz: 6e85b1ec840dd0bb45da7eec64fb4b0a0727cf99fadc08a6a2f8a1b6a389a280b6ea36420bb611f645be77f19c351b00651f08d32e9448f904f1e4b1e0a91ee4
-  data.tar.gz: 7e4fcd61713c55989078272a458b98fddb6399eacf36e5dc0d2678925799a48179097cec35bcc0f2332569b432d1c275fd5b25c50ba5d2fe4f3697c6c8f7ec69
+  metadata.gz: 615ea980593082a11de74ad48d342df7ea3d5af4a39c9ae467280990ec6fcbc54c6589fe40e824b0ce7429f041707eb6953f71eb6bc3bcd23146ba37d3d98737
+  data.tar.gz: 73174f09ca4246a44b357d2f6c9b86daf01808623766877f04b59f210dcb581f056b32954aa9d2e919384d7a371bb0edbc720d3196867b9631cf8375d8f76e79

data/.github/workflows/ci.yml

@@ -0,0 +1,79 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ] 
+  release:
+    types: [created]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake test spec audit
+    - name: Upload results for coverage
+      uses: actions/upload-artifact@v1
+      with:
+        name: coverage
+        path: coverage/
+      
+  coverage:
+    needs: [ test ]
+    name: coverage
+    runs-on: ubuntu-latest
+    steps: 
+    - uses: actions/checkout@v2
+    - name: Download tests result from test
+      uses: actions/download-artifact@v1
+      with:
+        name: coverage
+    - name: Install Code Climate test-reporter
+      run: |
+        curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+        chmod +x ./cc-test-reporter       
+    - name: Format code coverage
+      env:
+        GIT_BRANCH: ${{ github.ref }}
+        GIT_COMMIT_SHA: ${{ github.sha }}
+      run: |
+        export GIT_COMMITTED_AT="$(date +%s)"
+        ./cc-test-reporter format-coverage -d -t simplecov -o coverage/codeclimate.json coverage/.resultset.json 
+    - name: Publish code coverage
+      env:
+        GIT_BRANCH: ${{ github.ref }}
+        GIT_COMMIT_SHA: ${{ github.sha }}
+      run: |
+        export GIT_COMMITTED_AT="$(date +%s)"
+        ./cc-test-reporter upload-coverage -d -r ${{secrets.CC_TEST_REPORTER_ID}}
+
+  publish:
+    needs: [ test ]
+    name: publish
+    runs-on: ubuntu-latest
+    if: contains(github.ref, '/tags/v')
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          version: 2.6.x
+      - name: Publish to RubyGems
+        env:
+          GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem

data/.gitignore

@@ -5,3 +5,4 @@ spec/debug/
 coverage/
 TAGS
 Gemfile.lock
+*.gem

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
   Include:
     - '**/Rakefile'
   Exclude:

data/README.md

@@ -2,9 +2,10 @@
 
 # Fog::Proxmox
 
-[![Build Status](https://travis-ci.org/fog/fog-proxmox.svg?branch=master)](https://travis-ci.org/fog/fog-proxmox)
+![CI](https://github.com/fog/fog-proxmox/workflows/CI/badge.svg)
 [![Maintainability](https://api.codeclimate.com/v1/badges/33e619f2167cc9864b61/maintainability)](https://codeclimate.com/github/fog/fog-proxmox/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/33e619f2167cc9864b61/test_coverage)](https://codeclimate.com/github/fog/fog-proxmox/test_coverage)
+[![Gem Version](https://badge.fury.io/rb/fog-proxmox.svg)](https://badge.fury.io/rb/fog-proxmox)
 
 This is a [FOG](http://fog.io/) (>= 2.1) module gem to support [Proxmox VE](https://www.proxmox.com/en/proxmox-ve)
 
@@ -21,6 +22,7 @@ It is inspired by the great [fog-openstack](https://github.com/fog/fog-openstack
 |>=0.8|>=5.4|>=1.45|>=2.3|
 |>=0.9|>=6.0|>=2.1|>=2.3|
 |>=0.10|>=6.0|>=2.1|>=2.5|
+|>=0.14|>=6.2|>=2.1|>=2.5|
 
 ## Installation
 
@@ -57,7 +59,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 To record your VCR cassettes:
 
 ```shell
-PVE_URL=https://192.168.56.101:8006/api2/json DISABLE_PROXY=true SSL_VERIFY_PEER=false bundle exec rake spec
+PROXMOX_URL=https://192.168.56.101:8006/api2/json DISABLE_PROXY=true SSL_VERIFY_PEER=false bundle exec rake spec
 ```
 
 To replay your recorded tests:
@@ -66,6 +68,12 @@ To replay your recorded tests:
 USE_VCR=true bundle exec rake spec
 ```
 
+Code formatting:
+
+```shell
+bundle exec bin/rake rubocop  
+```
+
 ## Contributing
 
 You can reach the [contributors](.github/CONTRIBUTORS.md).

data/docs/compute.md

@@ -18,16 +18,32 @@ require 'fog/proxmox'
 
 ## Create compute service
 
+with access ticket:
+
+```ruby
+identity = Fog::Proxmox::Identity.new(
+	proxmox_url: 'https://localhost:8006/api2/json', 
+	proxmox_auth_method: 'access_ticket', 
+	proxmox_username: 'your_user@your_realm', 
+	proxmox_password: 'his_password',
+	connection_options: { ... }
+)      
+```
+
+with API user token:
+
 ```ruby
-compute = Fog::Proxmox::Compute.new(
-        pve_username: PVE_USERNAME, # your user name
-        pve_password: PVE_PASSWORD, # your password
-		pve_url: PVE_URL, # your server url
-		connection_options: {} # connection options
-)
+identity = Fog::Proxmox::Identity.new(
+	proxmox_url: 'https://localhost:8006/api2/json', 
+	proxmox_auth_method: 'user_token', 
+	proxmox_userid: 'your_user', 
+	proxmox_tokenid: 'his_tokenid',
+	proxmox_token: 'his_token',
+	connection_options: { ... }
+)      
 ```
 
-[connection_options](connection_parameters.md) are also available.
+[connection_options](connection_parameters.md) are also available and optional.
 
 ## Fog Abstractions
 

data/docs/identity.md

@@ -18,16 +18,32 @@ require 'fog/proxmox'
 
 ## Create identity service
 
+with access ticket:
+
+```ruby
+identity = Fog::Proxmox::Identity.new(
+	proxmox_url: 'https://localhost:8006/api2/json', 
+	proxmox_auth_method: 'access_ticket', 
+	proxmox_username: 'your_user@your_realm', 
+	proxmox_password: 'his_password',
+	connection_options: { ... }
+)      
+```
+
+with API user token:
+
 ```ruby
 identity = Fog::Proxmox::Identity.new(
-        pve_username: PVE_USERNAME, # your user name
-        pve_password: PVE_PASSWORD, # your password
-        pve_url: PVE_URL, # your server url
-		connection_options: {} # connection options
-)
+	proxmox_url: 'https://localhost:8006/api2/json', 
+	proxmox_auth_method: 'user_token', 
+	proxmox_userid: 'your_user@your_realm', 
+	proxmox_tokenid: 'his_tokenid',
+	proxmox_token: 'his_token',
+	connection_options: { ... }
+)      
 ```
 
-[connection_options](connection_parameters.md) are also available.
+[connection_options](connection_parameters.md) are also available and optional.
 
 ## Fog Abstractions
 
@@ -312,6 +328,15 @@ identity.permissions.remove({
     users: 'bobsinclar@pve'
 })
 ```
+
+User permissions:
+
+
+```ruby
+bob = identity.users.get 'bobsinclar@pve'
+bob.permissions
+```
+
 #### Pools management
 
 Proxmox supports pools management of VMs or storages. It eases managing permissions on these.

data/examples/compute.rb

@@ -19,22 +19,22 @@
 
 # There are basically two modes of operation for these specs.
 #
-# 1. ENV[PVE_URL] exists: talk to an actual Proxmox server and record HTTP
+# 1. ENV[PROXMOX_URL] exists: talk to an actual Proxmox server and record HTTP
 #    traffic in VCRs at "spec/debug" (credentials are read from the conventional
-#    environment variables: PVE_URL, PVE_USERNAME, PVE_PASSWORD)
+#    environment variables: PROXMOX_URL, PROXMOX_USERNAME, PROXMOX_PASSWORD)
 # 2. otherwise (Travis, etc): use VCRs at "spec/fixtures/proxmox/#{service}"
 
 require 'fog/proxmox'
 
-pve_url = 'https://172.26.49.146:8006/api2/json'
-pve_username = 'root@pam'
-pve_password = 'proxmox01'
+proxmox_url = 'https://172.26.49.146:8006/api2/json'
+proxmox_username = 'root@pam'
+proxmox_password = 'proxmox01'
 
 # Create service compute
 compute = Fog::Proxmox::Compute.new(
-  pve_url: pve_url,
-  pve_username: pve_username,
-  pve_password: pve_password
+  proxmox_url: proxmox_url,
+  proxmox_username: proxmox_username,
+  proxmox_password: proxmox_password
 )
 
 # Create pools
@@ -62,7 +62,7 @@ pool1.destroy
 # Create servers
 
 # Get node owner
-node_name = 'pve'
+node_name = 'proxmox'
 node = compute.nodes.get node_name
 
 # Get next free vmid
@@ -170,7 +170,7 @@ server.config.disks
 server.destroy
 
 # Create containers
-node_name = 'pve'
+node_name = 'proxmox'
 node = compute.nodes.get node_name
 ostemplate = 'local:vztmpl/alpine-3.7-default_20171211_amd64.tar.xz'
 container_hash = {
@@ -267,7 +267,7 @@ container.destroy
 
 # List 1 task
 filters = { limit: 1 }
-node = compute.nodes.get 'pve'
+node = compute.nodes.get 'proxmox'
 tasks = node.tasks.all(filters)
 # Get task
 upid = tasks[0].upid

data/examples/identity.rb

@@ -20,30 +20,40 @@
 
 # There are basically two modes of operation for these specs.
 #
-# 1. ENV[PVE_URL] exists: talk to an actual Proxmox server and record HTTP
+# 1. ENV[PROXMOX_URL] exists: talk to an actual Proxmox server and record HTTP
 #    traffic in VCRs at "spec/debug" (credentials are read from the conventional
-#    environment variables: PVE_URL, PVE_USERNAME, PVE_PASSWORD)
+#    environment variables: PROXMOX_URL, PROXMOX_USERNAME, PROXMOX_PASSWORD)
 # 2. otherwise (Travis, etc): use VCRs at "spec/fixtures/proxmox/#{service}"
 
 require 'fog/proxmox'
 
-pve_url = 'https://172.26.49.146:8006/api2/json'
-pve_username = 'root@pam'
-pve_password = 'proxmox01'
+proxmox_url = 'https://172.26.49.146:8006/api2/json'
+proxmox_username = 'root@pam'
+proxmox_password = 'proxmox01'
 
-# Create service identity
+# Create service identity with access ticket
 identity = Fog::Proxmox::Identity.new(
-  pve_url: pve_url,
-  pve_username: pve_username,
-  pve_password: pve_password
+  proxmox_url: proxmox_url,
+  proxmox_auth_method: 'access_ticket',
+  proxmox_username: proxmox_username,
+  proxmox_password: proxmox_password
 )
 
+# or with a user token
+identity = Fog::Proxmox::Identity.new(
+	proxmox_url: proxmox_url, 
+	proxmox_auth_method: 'user_token', 
+	proxmox_userid: proxmox_username, 
+	proxmox_tokenid: 'root1',
+	proxmox_token: 'ed6402b4-641d-46b1-b20a-33ba9ba12f54'
+)      
+
 # Get proxmox version
 identity.read_version
 
 # Create a new user
 bob_hash = {
-  userid: 'bobsinclar@pve',
+  userid: 'bobsinclar@proxmox',
   password: 'bobsinclar1',
   firstname: 'Bob',
   lastname: 'Sinclar',
@@ -53,7 +63,7 @@ bob_hash = {
 identity.users.create(bob_hash)
 
 # Get a user by id
-bob = identity.users.get 'bobsinclar@pve'
+bob = identity.users.get 'bobsinclar@proxmox'
 
 # List all users
 identity.users.all
@@ -69,6 +79,9 @@ bob.comment = 'novelist'
 bob.groups = %w[group1]
 bob.update
 
+# List user permissions
+bob.permissions
+
 # Delete user
 bob.destroy
 
@@ -117,8 +130,8 @@ end
 role1.destroy
 
 # Create a new domain (authentication server)
-# Three types: PAM, PVE, LDAP and ActiveDirectory
-# PAM and PVE already exist by default
+# Three types: PAM, PROXMOX, LDAP and ActiveDirectory
+# PAM and PROXMOX already exist by default
 # LDAP sample:
 ldap_hash = {
   realm: 'LDAP',
@@ -165,14 +178,14 @@ ldap.destroy
 permission_hash = {
   type: 'user'
   path: '/access',
-  roleid: 'PVEUserAdmin',
+  roleid: 'PROXMOXUserAdmin',
   ugid: bob_hash[:userid]
 }
 # Add a group permission
 # permission_hash = {
 #   type: 'group'
 #   path: '/access',
-#   roleid: 'PVEUserAdmin',
+#   roleid: 'PROXMOXUserAdmin',
 #   ugid: 'group1'
 # }
 permission = identity.permissions.create(permission_hash)

data/fog-proxmox.gemspec

@@ -40,6 +40,7 @@ Gem::Specification.new do |spec|
   spec.rubygems_version = '~> 2.6'
 
   spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'bundler-audit', '~> 0.6'
   spec.add_development_dependency 'debase', '~> 0.2.2'
   spec.add_development_dependency 'debride', '~> 1.8'
   spec.add_development_dependency 'fasterer', '~> 0.3'
@@ -52,10 +53,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.7'
   spec.add_development_dependency 'rubocop', '~> 0.55'
   spec.add_development_dependency 'ruby-debug-ide', '~> 0.6'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov', '0.17'
   spec.add_development_dependency 'vcr', '~> 4.0'
   spec.add_development_dependency 'webmock', '~> 3.5'
-  spec.add_development_dependency 'bundler-audit', '~> 0.6'
 
   spec.add_dependency 'fog-core',  '~> 2.1'
   spec.add_dependency 'fog-json',  '~> 1.2'

data/lib/fog/proxmox.rb

@@ -18,98 +18,38 @@
 
 # frozen_string_literal: true
 
-require 'fog/proxmox/version'
-require 'fog/proxmox/core'
-require 'fog/proxmox/json'
 require 'fog/core'
 require 'fog/json'
 
 module Fog
   # Proxmox module
   module Proxmox
+
+    require 'fog/proxmox/auth/token'
+
+    autoload :Core, 'fog/proxmox/core'
+    autoload :Errors, 'fog/proxmox/errors'
+    autoload :Identity, 'fog/proxmox/identity'
+    autoload :Compute, 'fog/proxmox/compute'
+    autoload :Storage, 'fog/proxmox/storage'
+    autoload :Network, 'fog/proxmox/network'
+
     extend Fog::Provider
-    autoload :Identity, File.expand_path('identity/proxmox', __dir__)
-    autoload :Compute, File.expand_path('compute/proxmox', __dir__)
-    autoload :Storage, File.expand_path('storage/proxmox', __dir__)
-    autoload :Network, File.expand_path('network/proxmox', __dir__)
+    
     service(:identity, 'Identity')
     service(:compute, 'Compute')
     service(:storage, 'Storage')
     service(:network, 'Network')
 
-    @credentials = {}
+    @token_cache = {}
 
     class << self
-      attr_reader :credentials
-      attr_reader :version
-    end
-
-    def self.clear_credentials
-      @credentials = {}
-    end
-
-    def self.authenticate(options, connection_options = {})
-      get_credentials(options, connection_options)
-      self
-    end
-
-    def self.authenticated?
-      !@credentials.empty?
-    end
-
-    def self.credentials_has_expired?
-      authenticated? && @credentials[:deadline] < Time.now
-    end
-
-    def self.extract_password(options)
-      ticket = options[:pve_ticket]
-      ticket ? ticket : options[:pve_password].to_s
-    end
-
-    def self.get_credentials(options, connection_options = {})
-      pve_ticket_lifetime   = options[:pve_ticket_lifetime]
-      # Default lifetime ticket is 2 hours
-      ticket_lifetime = pve_ticket_lifetime ? pve_ticket_lifetime : 2 * 60 * 60
-      username          = options[:pve_username].to_s
-      password          = extract_password(options)
-      url               = options[:pve_url]
-      uri = URI.parse(url)
-      @api_path = uri.path
-      connection_options = connection_options.merge(path_prefix: @api_path)
-      password = @credentials[:ticket] if credentials_has_expired?
-      request_credentials(uri, connection_options, username, password, ticket_lifetime)
-    end
-
-    def self.request_credentials(uri, connection_options, username, password, ticket_lifetime)
-      request = {
-        expects: [200, 204],
-        headers: { 'Accept' => 'application/json' },
-        body: URI.encode_www_form(username: username, password: password),
-        method: 'POST',
-        path: 'access/ticket'
-      }
-      connection = Fog::Core::Connection.new(
-        uri.to_s,
-        false,
-        connection_options
-      )
-      response  = connection.request(request)
-      data      = Json.get_data(response)
-      ticket    = data['ticket']
-      username  = data['username']
-      csrftoken = data['CSRFPreventionToken']
-      epoch = Time.now.to_i + ticket_lifetime
-      deadline = Time.at(epoch)
-      save_credentials(username, ticket, csrftoken, deadline)
+      attr_accessor :token_cache
     end
 
-    def self.save_credentials(username, ticket, csrftoken, deadline)
-      @credentials = {
-        username: username,
-        ticket: ticket,
-        csrftoken: csrftoken,
-        deadline: deadline
-      }
+    def self.clear_token_cache
+      Fog::Proxmox.token_cache = {}
     end
+    
   end
 end