<html xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Title" content="">
<meta name="Keywords" content="">
<meta name="Generator" content="Microsoft Word 15 (filtered medium)">
<style><!--
/* Font Definitions */
@font-face
{font-family:"Cambria Math";
panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
{font-family:Calibri;
panose-1:2 15 5 2 2 2 4 3 2 4;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0cm;
margin-bottom:.0001pt;
font-size:12.0pt;
font-family:"Times New Roman";}
a:link, span.MsoHyperlink
{mso-style-priority:99;
color:blue;
text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
{mso-style-priority:99;
color:purple;
text-decoration:underline;}
p
{mso-style-priority:99;
margin:0cm;
margin-bottom:.0001pt;
font-size:12.0pt;
font-family:"Times New Roman";}
span.EmailStyle18
{mso-style-type:personal-reply;
font-family:Calibri;
color:windowtext;}
span.msoIns
{mso-style-type:export-only;
mso-style-name:"";
text-decoration:underline;
color:teal;}
.MsoChpDefault
{mso-style-type:export-only;
font-size:10.0pt;}
@page WordSection1
{size:612.0pt 792.0pt;
margin:72.0pt 72.0pt 72.0pt 72.0pt;}
div.WordSection1
{page:WordSection1;}
--></style>
</head>
<body bgcolor="white" lang="EN-US" link="blue" vlink="purple">
<div class="WordSection1">
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:Calibri"><o:p> </o:p></span></p>
<div style="border:none;border-top:solid #B5C4DF 1.0pt;padding:3.0pt 0cm 0cm 0cm">
<p class="MsoNormal" style="margin-left:36.0pt"><b><span style="font-family:Calibri;color:black">From:
</span></b><span style="font-family:Calibri;color:black">Maxime Belanger <mbelanger@internap.com><br>
<b>Reply-To: </b>"OpenStack Development Mailing List (not for usage questions)" <openstack-dev@lists.openstack.org><br>
<b>Date: </b>Thursday, December 22, 2016 at 9:32 AM<br>
<b>To: </b>"openstack-dev@lists.openstack.org" <openstack-dev@lists.openstack.org><br>
<b>Subject: </b>[openstack-dev] [Ironic] python-ironicclient weird behaviour<o:p></o:p></span></p>
</div>
<div>
<p class="MsoNormal" style="margin-left:36.0pt"><o:p> </o:p></p>
</div>
<div id="divtagdefaultwrapper">
<p style="margin-left:36.0pt"><span style="font-family:Calibri;color:black">Hi Ironic folks,
<o:p></o:p></span></p>
<p style="margin-left:36.0pt"><span style="font-family:Calibri;color:black"><o:p> </o:p></span></p>
<p style="margin-left:36.0pt"><span style="font-family:Calibri;color:black">Yesterday I come across a weird behaviour in python-ironicclient. I discussed briefly with the problem with Julia and befor creating a bug I would like your opinion on the problem and
potential fix.<o:p></o:p></span></p>
<p style="margin-left:36.0pt"><span style="font-family:Calibri;color:black"><o:p> </o:p></span></p>
<p style="margin-left:36.0pt"><span style="font-family:Calibri;color:black">When doing nodes.get(resource_id=None), I get back a Node object set with attribute nodes={nodes: [{uuid: 'blah'}, {uuid: 'bleh'}]}. I guess that is not expected which is the bug I
found and I know where to fix it if we agree to not change the behavour: If resource_id=None the client is doing a GET on /v1/nodes which is expected here : <a href="https://github.com/openstack/python-ironicclient/blob/1.8.0/ironicclient/common/base.py#L55" id="LPlnk376222">https://github.com/openstack/python-ironicclient/blob/1.8.0/ironicclient/common/base.py#L55</a>.<o:p></o:p></span></p>
<p style="margin-left:36.0pt"><span style="font-family:Calibri;color:black"><o:p> </o:p></span></p>
<p style="margin-left:36.0pt"><span style="font-family:Calibri;color:black">The thing is, returning the first item of the list while doing a get on something that doesn't exists is a bit strange. I do not want to do extra validation on my application side to
not pass None to the ironicclient. I would it to behave correctly: 404 or a even a 400.<o:p></o:p></span></p>
<p style="margin-left:36.0pt"><span style="font-family:Calibri;color:black"><o:p> </o:p></span></p>
<p style="margin-left:36.0pt"><span style="font-family:Calibri;color:black">What do you think/or prefer?<o:p></o:p></span></p>
<p><span style="font-family:Calibri;color:black"><o:p> </o:p></span></p>
<p style="margin-left:36.0pt"><span style="font-family:Calibri;color:black">A. Fixing the bug and not changing actual behaviour of the API<o:p></o:p></span></p>
<p style="margin-left:36.0pt"><span style="font-family:Calibri;color:black">B. Changing the API behaviour and returning a 404 error since resource None is not found<o:p></o:p></span></p>
<p style="margin-left:36.0pt"><span style="font-family:Calibri;color:black">C. Changing the API behaviour and returning a 400 error because None is not a valid request. The will be identical to the command line that is doing this:<o:p></o:p></span></p>
<div>
<p class="MsoNormal" style="margin-left:36.0pt"><span style="font-family:Calibri;color:black">ironic node-show None<o:p></o:p></span></p>
</div>
<div>
<p class="MsoNormal" style="margin-left:36.0pt"><span style="font-family:Calibri;color:black">Invalid input for field/attribute node_ident. Value: 'None'. unable to convert to uuid_or_name (HTTP 400)<o:p></o:p></span></p>
</div>
<div>
<p class="MsoNormal" style="margin-left:36.0pt"><span style="font-family:Calibri;color:black"><o:p> </o:p></span></p>
</div>
<div>
<p class="MsoNormal" style="margin-left:36.0pt"><span style="font-family:Calibri;color:black">Thanks<o:p></o:p></span></p>
</div>
<div>
<p class="MsoNormal" style="margin-left:36.0pt"><span style="font-family:Calibri;color:black">Max<o:p></o:p></span></p>
</div>
<p class="MsoNormal"><span style="font-family:Calibri;color:black"><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:Calibri;color:black">Thanks for tripping over this! :-( I think this is a bug in the API. I think it is just a coincidence that it happens to return the list of nodes (because the generated HTTP request works).
That code should be checking that resource_id is non-empty -- that's what the CLI does. And if it isn't, raise an exception. I vote for B, sort of. It shouldn't return an http status error since no http request should be made. Looking at the existing exceptions,
I'm guessing InvalidAttribute or ValidationError? <o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:Calibri;color:black"><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:Calibri;color:black">Your C above is a different situation, 'None' is a string that is the name of a node, but that string doesn't conform to the allowed name syntax.<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:Calibri;color:black"><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-family:Calibri;color:black">--ruby<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-family:Calibri;color:black"><o:p> </o:p></span></p>
</div>
</div>
</body>
</html>