right_link 5.9.0

data/lib/chef/windows/ChefNodeCmdlet/ChefNodeCmdlet/GetNodeValueCommandBase.cs

@@ -0,0 +1,142 @@
+/////////////////////////////////////////////////////////////////////////
+// Copyright (c) 2010-2011 RightScale Inc
+//
+// 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.
+/////////////////////////////////////////////////////////////////////////
+using System;
+using System.Collections;
+using System.Management.Automation;
+using System.Threading;
+using RightScale.Common.Protocol;
+using RightScale.Chef.Protocol;
+using RightScale.Powershell.Exceptions;
+
+namespace RightScale
+{
+    namespace Powershell
+    {
+        namespace Commands
+        {
+            // Provides a base class for get node commands.
+            public abstract class GetNodeValueCommandBase : Cmdlet
+            {
+                // Path to distinguish child element being requested.
+                [Parameter(ValueFromPipeline = true, Position = 0)]
+                public string[] Path
+                {
+                    get { return path; }
+                    set { path = value; }
+                }
+
+                // Summary:
+                //  Factory method for request from cmdlet parameters.
+                //
+                // Returns:
+                //  request object
+                protected abstract GetNodeValueRequestBase CreateRequest();
+
+                // Summary:
+                //  Factory method for exception from message.
+                //
+                // Returns:
+                //  exception
+                protected abstract ChefNodeCmdletExceptionBase CreateException(string message);
+
+                // Summary:
+                //  Factory method for exception from response hash.
+                //
+                // Returns:
+                //  exception
+                protected abstract ChefNodeCmdletExceptionBase CreateException(IDictionary responseHash);
+
+                // Summary:
+                //  implements required cmdlet processing method.
+                protected override void ProcessRecord()
+                {
+                    // iterate attempting to connect, send and receive to Chef node server.
+                    for (int tryIndex = 0; tryIndex < Constants.MAX_CLIENT_RETRIES; ++tryIndex)
+                    {
+                        ITransport transport = new JsonTransport();
+                        PipeClient pipeClient = new PipeClient(Constants.CHEF_NODE_PIPE_NAME, transport);
+
+                        try
+                        {
+                            GetNodeValueRequestBase request = CreateRequest();
+
+                            pipeClient.Connect(Constants.CHEF_NODE_CONNECT_TIMEOUT_MSECS);
+
+                            IDictionary responseHash = (IDictionary)transport.NormalizeDeserializedObject(pipeClient.SendReceive<object>(request));
+
+                            if (null == responseHash)
+                            {
+                                if (tryIndex + 1 < Constants.MAX_CLIENT_RETRIES)
+                                {
+                                    // delay retry a few ticks to yield time in case server is busy.
+                                    Thread.Sleep(Constants.SLEEP_BETWEEN_CLIENT_RETRIES_MSECS);
+                                    continue;
+                                }
+                                else
+                                {
+                                    string message = String.Format("Failed to get expected response after {0} retries.", Constants.MAX_CLIENT_RETRIES);
+
+                                    throw CreateException(message);
+                                }
+                            }
+                            if (ChefNodeCmdletExceptionBase.HasError(responseHash))
+                            {
+                                throw CreateException(responseHash);
+                            }
+
+                            // can't write a null object to pipeline, so write nothing in the null case.
+                            object nodeValue = responseHash.Contains(Constants.JSON_NODE_VALUE_KEY) ? responseHash[Constants.JSON_NODE_VALUE_KEY] : null;
+
+                            if (null != nodeValue)
+                            {
+                                WriteObject(nodeValue, nodeValue is ICollection);
+                            }
+
+                            // done.
+                            break;
+                        }
+                        catch (TimeoutException e)
+                        {
+                            ThrowTerminatingError(new ErrorRecord(e, "Connection timed out", ErrorCategory.OperationTimeout, pipeClient));
+                        }
+                        catch (ChefNodeCmdletExceptionBase e)
+                        {
+                            ThrowTerminatingError(new ErrorRecord(e, "ChefNodeCmdlet exception", ErrorCategory.InvalidResult, pipeClient));
+                        }
+                        catch (Exception e)
+                        {
+                            ThrowTerminatingError(new ErrorRecord(e, "Unexpected exception", ErrorCategory.NotSpecified, pipeClient));
+                        }
+                        finally
+                        {
+                            pipeClient.Close();
+                            pipeClient = null;
+                        }
+                    }
+                }
+
+                private string[] path;
+            }
+        }
+    }
+}

data/lib/chef/windows/ChefNodeCmdlet/ChefNodeCmdlet/GetNodeValueRequestBase.cs

@@ -0,0 +1,64 @@
+/////////////////////////////////////////////////////////////////////////
+// Copyright (c) 2010-2011 RightScale Inc
+//
+// 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.
+/////////////////////////////////////////////////////////////////////////
+using System;
+using System.Collections;
+
+namespace RightScale
+{
+    namespace Chef
+    {
+        namespace Protocol
+        {
+            // Provides a base class for a get node request.
+            public abstract class GetNodeValueRequestBase
+            {
+                public string Command
+                {
+                    get { return GetType().Name; }
+                }
+
+                public string[] Path
+                {
+                    get { return path; }
+                    set { path = value; }
+                }
+
+                public GetNodeValueRequestBase()
+                {
+                }
+
+                public GetNodeValueRequestBase(ICollection path)
+                {
+                    this.path = Utilities.CollectionToStringArray(path);
+                }
+
+                public override string ToString()
+                {
+                    return String.Format("{0}: {{ Path = node[{1}] }}", Command, String.Join("][", path));
+                }
+
+                private string[] path;
+            }
+        }
+    }
+}

data/lib/chef/windows/ChefNodeCmdlet/ChefNodeCmdlet/GetNodeValueResponseBase.cs

@@ -0,0 +1,69 @@
+/////////////////////////////////////////////////////////////////////////
+// Copyright (c) 2010-2011 RightScale Inc
+//
+// 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.
+/////////////////////////////////////////////////////////////////////////
+using System;
+
+namespace RightScale
+{
+    namespace Chef
+    {
+        namespace Protocol
+        {
+            // Provides a base class for a get node response.
+            public abstract class GetNodeValueResponseBase
+            {
+                public string[] Path
+                {
+                    get { return path; }
+                    set { path = value; }
+                }
+
+                public object NodeValue
+                {
+                    get { return nodeValue; }
+                    set { nodeValue = value; }
+                }
+
+                public GetNodeValueResponseBase()
+                {
+                }
+
+                public GetNodeValueResponseBase(string[] path, object nodeValue)
+                {
+                    this.path = path;
+                    this.nodeValue = nodeValue;
+                }
+
+                public override string ToString()
+                {
+                    return String.Format("{0}: {{ Path = node[{1}], NodeValue = {2} }}",
+                                         GetType().Name,
+                                         String.Join("][", path),
+                                         Utilities.GetPrettyNodeValue(NodeValue));
+                }
+
+                private string[] path;
+                private object nodeValue;
+            }
+        }
+    }
+}

data/lib/chef/windows/ChefNodeCmdlet/ChefNodeCmdlet/JsonTransport.cs

@@ -0,0 +1,110 @@
+/////////////////////////////////////////////////////////////////////////
+// Copyright (c) 2010-2011 RightScale Inc
+//
+// 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.
+/////////////////////////////////////////////////////////////////////////
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+
+namespace RightScale
+{
+    namespace Common
+    {
+        namespace Protocol
+        {
+            // implements ITransport in terms of JSON serialization.
+            public class JsonTransport : ITransport
+            {
+                string ITransport.ConvertObjectToString(object data)
+                {
+                    return JsonConvert.SerializeObject(data);
+                }
+
+                string ITransport.ConvertObjectToString(object data, bool pretty)
+                {
+                    return JsonConvert.SerializeObject(data, pretty ? Formatting.Indented : Formatting.None);
+                }
+
+                T ITransport.ConvertStringToObject<T>(string data)
+                {
+                    return JsonConvert.DeserializeObject<T>(data);
+                }
+
+                object ITransport.NormalizeDeserializedObject(object data)
+                {
+                    return NormalizeValue(data);
+                }
+
+                // Summary:
+                //  implements normalization in terms of the inner types used by this
+                //  JSON library. only handles known JSON types and returns any other
+                //  types unchanged.
+                //
+                // Parameters:
+                //   data:
+                //      data to normalize.
+                //
+                // Returns:
+                //  normalized data
+                private static object NormalizeValue(object data)
+                {
+                    if (data is JValue)
+                    {
+                        JValue customValue = (JValue)data;
+
+                        return customValue.Value;
+                    }
+                    if (data is JObject)
+                    {
+                        JObject jobject = (JObject)data;
+                        Hashtable normalHash = new Hashtable();
+
+                        foreach (JProperty jproperty in jobject.Properties())
+                        {
+                            string key = jproperty.Name;
+                            object value = jproperty.Value;
+
+                            normalHash[key] = NormalizeValue(value);
+                        }
+
+                        return normalHash;
+                    }
+                    if (data is JArray)
+                    {
+                        ICollection customCollection = (ICollection)data;
+                        ArrayList normalCollection = new ArrayList(customCollection.Count);
+
+                        foreach (object customObject in customCollection)
+                        {
+                            normalCollection.Add(NormalizeValue(customObject));
+                        }
+
+                        return normalCollection;
+                    }
+
+                    return data;
+                }
+            }
+        }
+    }
+}

data/lib/chef/windows/ChefNodeCmdlet/ChefNodeCmdlet/PipeClient.cs

@@ -0,0 +1,158 @@
+/////////////////////////////////////////////////////////////////////////
+// Copyright (c) 2010-2011 RightScale Inc
+//
+// 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.
+/////////////////////////////////////////////////////////////////////////
+using System;
+using System.IO;
+using System.IO.Pipes;
+
+namespace RightScale
+{
+    namespace Common
+    {
+        namespace Protocol
+        {
+            // represents a generic text-based pipe client which communicates via a user-supplied transport.
+            // the transport must convert requests/responses to discrete text messages delimited by newline.
+            public class PipeClient
+            {
+                // Summary:
+                //  constructor for a named pipe client.
+                //
+                // Parameters:
+                //   pipeName:
+                //      name of pipe to use when connecting to server.
+                public PipeClient(string pipeName, ITransport transport)
+                {
+                    this.pipeName = pipeName;
+                    this.transport = transport;
+                }
+
+                // Summary:
+                //  creates a bidirectional pipe client.
+                //
+                // Parameters:
+                //   timeoutMsecs:
+                //      timeout on waiting for connection in milliseconds
+                //
+                // Throws:
+                //   System.TimeoutException on failure to connect
+                public void Connect(int timeoutMsecs)
+                {
+                    // create bidirectional pipe client.
+                    pipeClient = new NamedPipeClientStream(pipeName);
+                    pipeClient.Connect(timeoutMsecs);
+
+                    // create writer.
+                    streamWriter = new StreamWriter(pipeClient);
+                    streamWriter.AutoFlush = true;
+
+                    // create reader.
+                    streamReader = new StreamReader(pipeClient);
+                }
+
+                // Summary:
+                //  sends a request without waiting for a response.
+                //
+                // Parameters:
+                //   request:
+                //      request to send
+                public void Send(object request)
+                {
+                    // send.
+                    string text = transport.ConvertObjectToString(request);
+
+                    streamWriter.WriteLine(text);
+                }
+
+                // Summary:
+                //  sends/receives a request/response pair.
+                //
+                // Parameters:
+                //   T:
+                //      expected type for response
+                //
+                //   request:
+                //      request to send
+                //
+                // Returns:
+                //   received response object
+                public T SendReceive<T>(object request)
+                {
+                    // send.
+                    Send(request);
+
+                    // receive.
+                    {
+                        string text = streamReader.ReadLine();
+
+                        return (null == text) ? default(T) : transport.ConvertStringToObject<T>(text);
+                    }
+                }
+
+                // Summary:
+                //  closes the client and releases all resources.
+                public void Close()
+                {
+                    if (null != streamReader)
+                    {
+                        try
+                        {
+                            streamReader.Close();
+                        }
+                        catch (Exception)
+                        {
+                        }
+                        streamReader = null;
+                    }
+                    if (null != streamWriter)
+                    {
+                        try
+                        {
+                            streamWriter.Close();
+                        }
+                        catch (Exception)
+                        {
+                        }
+                        streamWriter = null;
+                    }
+                    if (null != pipeClient)
+                    {
+                        try
+                        {
+                            pipeClient.Close();
+                        }
+                        catch (Exception)
+                        {
+                        }
+                        pipeClient = null;
+                    }
+                }
+
+                private ITransport transport = null;
+                private NamedPipeClientStream pipeClient = null;
+                private StreamReader streamReader = null;
+                private StreamWriter streamWriter = null;
+                private string pipeName = null;
+            }
+        }
+    }
+}