train-pwsh 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e116dd35ef28fabbaacb70352c42a8335d028949f7cd417418b2bce4b9bdd008
-  data.tar.gz: 23fe2e4625a8a8904899de5dada14a625e6e1aa1ee0ae627aa44a263e770ff2c
+  metadata.gz: 89e3a18c81cf9e11a8c44fab1922b73b7b131d79bc06e880f2465b0fa1855f86
+  data.tar.gz: 0eed86dd58bfeaa57ae2d838f24f8c1b29f518f012c55638f393e5b58fc0b3dd
 SHA512:
-  metadata.gz: 1d44661cc9311e5f20cdedc53ef30706758945d3b96e7e5ca4814d0127a1c73cc340897de239f583a60a06108536acf59e328e801d6bc1fb09fa491c2bc7b045
-  data.tar.gz: 6f8dc2b638115c43d20a967a653081ecd4927910f3d5dceac8d9836137c060fa73950b86c90fab478113f667a1220132144c80aaf6fa74db7883a9c104490428
+  metadata.gz: c03186763343739f788179381799a58b817012ae2d364de5c8a72f6d356950c25a8953449ef17343486c63cace359efba0548f5394d78c2e8f047154defb5edf
+  data.tar.gz: 9ac43a9c24bdf4d9612f323507ec58ff8579ec7c7b34a533ee04c3c9f6784f0f4d174ca5a58785cc584b578f94fcdfb4ca3c97bceee4941e3c5db0a1ed98338f

data/README.md

@@ -1,17 +1,24 @@
 # Train::Pwsh
 
-A train-pwsh connection has 7 fields that are needed for authentication, which are listed below:
-- client_id
-- tenant_id
-- client_secret
-- certificate_path
-- certificate_password
-- organization
-- sharepoint_admin_url
-
-These fields need to be defined in the config file stored at this directory: `~/.inspec/config.json`. Particularly, under the `credentials` key of the json file, create a `pwsh` key with the value being another dictionary. This dictionary should have a key named `pwsh-options` with the value being another dictionary. This dictionary should contain the names of the seven fields above as well as their values. Please refer to this [link](https://origin.inspec.io/docs/reference/config/) for more detailed instructions.
-
-Alternatively, if train is being invoked using code, this is how it can be used:
+A train-pwsh connection has eight fields that are needed for authentication, which are listed below:
+- client_id (id of client)
+- tenant_id (id of tenant)
+- client_secret (secret key for client)
+- certificate_path (path on machine where authentication certificate is stored)
+- certificate_password (password for certificate)
+- organization (organization domain)
+- sharepoint_admin_url (sharepoint url for admin)
+- pwsh_path (path on machine where the powershell executable is stored)
+
+These fields need to be defined in the config file stored at this directory: `~/.inspec/config.json`. Particularly, under the `credentials` key of the json file, create a `pwsh` key with the value being another dictionary. This dictionary should have a key named `pwsh-options` with the value being another dictionary. This dictionary should contain the names of the eight fields above as well as their values. Please refer to this [link](https://origin.inspec.io/docs/reference/config/) for more detailed instructions.
+
+On top of this, environment variables may need to be defined for some of these eight fields if they are to be used elsewhere in the profile as inputs. The README for the profile will specify which ones need to be stored as environment variables. 
+
+To set an environment variable on Mac, go to the `zschrc` file located at `~/.zschrc` and enter in the following syntax: `export VARIABLE_NAME='insert_value'`
+
+To se and environment variable on Windows, click `Win + R`, type `cmd`, and hit enter. Then, this syntax can be used `setx VARIABLE_NAME "Variable Value"`
+
+If train is being invoked using code, this is how it can be used:
 
 **Pwsh**
 

data/lib/train-pwsh/connection.rb

@@ -50,8 +50,11 @@ module TrainPlugins
         #Instance variables that store the necessary authentication credentials
         #@pwsh_session_graph_exchange = ::Pwsh::Manager.instance('/opt/homebrew/bin/pwsh', ['-NoLogo'])
         #@pwsh_session_teams_pnp = ::Pwsh::Manager.instance('/opt/homebrew/bin/pwsh', [])
-        @pwsh_session_graph_exchange = @options.delete(:graph_exchange_session)
-        @pwsh_session_teams_pnp = @options.delete(:teams_pnp_session)
+        @pwsh_path = @options.delete(:pwsh_path)
+        #@pwsh_session_graph_exchange = @options.delete(:graph_exchange_session)
+        #@pwsh_session_teams_pnp = @options.delete(:teams_pnp_session)
+        @pwsh_session_graph_exchange = ::Pwsh::Manager.instance("#{@pwsh_path}", ['-NoLogo'])
+        @pwsh_session_teams_pnp = ::Pwsh::Manager.instance("#{@pwsh_path}", [])
         @client_id = @options.delete(:client_id)
         @tenant_id = @options.delete(:tenant_id)
         @client_secret = @options.delete(:client_secret)
@@ -106,6 +109,7 @@ module TrainPlugins
           If($null -eq (get-module -name "ExchangeOnlineManagement")){import-module ExchangeOnlineManagement}
           $password = ConvertTo-SecureString -String $clientSecret -AsPlainText -Force
           $ClientSecretCredential = New-Object -TypeName System.Management.Automation.PSCredential($client_id,$password)
+          Connect-IPPSSession -AppID $client_id -CertificateFilePath $certificate_path -CertificatePassword (ConvertTo-SecureString -String $certificate_password -AsPlainText -Force) -Organization $organization -ShowBanner:$false
           Connect-ExchangeOnline -CertificateFilePath $certificate_path -CertificatePassword (ConvertTo-SecureString -String $certificate_password -AsPlainText -Force)  -AppID $client_id -Organization $organization -ShowBanner:$false
         }
         
@@ -144,11 +148,17 @@ module TrainPlugins
 
       def run_script_in_graph_exchange(script)
         result = @pwsh_session_graph_exchange.execute(script)
+        if result[:stdout].nil?
+          result[:stdout] = ""
+        end
         return CommandResult.new(result[:stdout],result[:stderr],result[:exitcode])
       end
 
       def run_script_in_teams_pnp(script)
         result = @pwsh_session_teams_pnp.execute(script)
+        if result[:stdout].nil?
+          result[:stdout] = ""
+        end
         return CommandResult.new(result[:stdout],result[:stderr],result[:exitcode])
       end
     end

data/lib/train-pwsh/transport.rb

@@ -20,9 +20,6 @@ module TrainPlugins
       #option :certificate_password, required: true, default: proc { ENV['CERTIFICATE_PASSWORD'] } unless ENV['CERTIFICATE_PASSWORD'].empty? 
       #option :organization, required: true, default: proc { ENV['ORGANIZATION'] } unless ENV['ORGANIZATION'].empty? 
       #option :sharepoint_admin_url, required: true, default: proc { ENV['SHAREPOINT_ADMIN_URL'] } unless ENV['SHAREPOINT_ADMIN_URL'].empty? 
-
-      option :graph_exchange_session, required: true, default: proc { ::Pwsh::Manager.instance(ENV['PWSH_PATH'], ['-NoLogo']) }
-      option :teams_pnp_session, required: true, default: proc { ::Pwsh::Manager.instance(ENV['PWSH_PATH'], []) }
       
       # The options passed to this are undocumented and rarely used.
       def connection(_instance_opts = nil)

data/lib/train-pwsh/version.rb

@@ -2,6 +2,6 @@
 
 module Train
   module Pwsh
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-pwsh
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Sujay Kandwal
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-20 00:00:00.000000000 Z
+date: 2024-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: train