Bug 726114

Summary: api call configchannel.createorupdatepath's documentation does not reflect the actual api usage
Product: Red Hat Satellite 5 Reporter: Felix Dewaleyne <fdewaley>
Component: APIAssignee: Tomas Lestach <tlestach>
Status: CLOSED CURRENTRELEASE QA Contact: Dimitar Yordanov <dyordano>
Severity: low Docs Contact:
Priority: medium    
Version: 541CC: cperry, dyordano, jhutar, mminar, mmraka
Target Milestone: ---Keywords: Reopened
Target Release: ---   
Hardware: All   
OS: All   
Whiteboard:
Fixed In Version: spacewalk-java-1.7.54-67 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2012-09-21 09:19:47 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 819036    
Attachments:
Description Flags
sample python script to reproduce this case. none

Description Felix Dewaleyne 2011-07-27 15:02:48 UTC
Created attachment 515543 [details]
sample python script to reproduce this case.

Description of problem:
the documentation of configchannel.createOrUpdatePath mentions a struct with "macro-start-delimiter" and "macro-stop-delimiter" saying that these two values should be ignored by the satellite, but actually satellite rejects these values

Version-Release number of selected component (if applicable):
confirmed in 5.4.1

How reproducible:
all the time

Steps to Reproduce:
1. register a machine to a satellite to a org channel called "test"
2. use the sample script attached to the ticket

  
Actual results:
the call fails with 
group': 'root', 'permissions': '0755', 'macro-start-delimiter': '', 'macro-end-delimiter': '', 'revision': 1 })
  File "/usr/lib64/python2.4/xmlrpclib.py", line 1096, in __call__
    return self.__send(self.__name, args)
  File "/usr/lib64/python2.4/xmlrpclib.py", line 1383, in __request
    verbose=self.__verbose
  File "/usr/lib64/python2.4/xmlrpclib.py", line 1147, in request
    return self._parse_response(h.getfile(), sock)
  File "/usr/lib64/python2.4/xmlrpclib.py", line 1286, in _parse_response
    return u.close()
  File "/usr/lib64/python2.4/xmlrpclib.py", line 744, in close
    raise Fault(**self._stack[0])
xmlrpclib.Fault: <Fault 2801: 'redstone.xmlrpc.XmlRpcFault: Invalid argument(s): macro-end-delimiter, macro-start-delimiter'>

Expected results:
the script should have passed, according to the documentation.

Additional info:
The will here is to get the documentation updated so that these values are taken down from 

	http://docs.redhat.com/docs/en-US/Red_Hat_Network_Satellite/5.4.1/html/API_Overview/handlers/ConfigChannelHandler.html#createOrUpdatePath

	(the folder part only)

 as they won't be accepted by the api.

Comment 2 Tomas Lestach 2011-07-29 16:48:47 UTC
The sample script says the upload path is a directory. It does not make sense to set macro delimiters for directories.

When the 4th API call argument (isDir) is set to False, the file will correctly be uploaded.

The behavior is correct.

Closing as NOTABUG.

Comment 4 Tomas Lestach 2011-10-25 08:48:02 UTC
All right, Felix, reopening.

Comment 5 Tomas Lestach 2011-10-25 08:51:28 UTC
spacewalk.git: 6d89779cf6bdc69a8480e39efe7fd58624b3558a

Comment 7 Tomas Lestach 2012-03-16 09:48:25 UTC
After fixing of Bug 801463, updating the API documetation ...

spacewalk.git: 8318f7ac448672c9a2e80070d3bafc1cc98dd426

Comment 8 Tomas Lestach 2012-03-16 11:05:16 UTC
checkstyle issue: b3d1461bb847f87d279f67963be3f21b4ce9ea06

Comment 16 Clifford Perry 2012-09-21 09:19:47 UTC
This issue is resolved with the release of RHN Satellite 5.5. 

As of September 20th 2012, RHN Satellite 5.5 has been generally available. 

Release Notes and other 5.5 documentation can be found here:

 https://access.redhat.com/knowledge/docs/Red_Hat_Network_Satellite/

The associated Errata for the 5.5 release are:

5.5 Satellite GA Errata
 - http://rhn.redhat.com/errata/RHEA-2012-1296.html

5.5 Upgrade Errata
 - http://rhn.redhat.com/errata/RHEA-2012-1298.html

5.5 RHN Proxy GA Errata
 - http://rhn.redhat.com/errata/RHEA-2012-1297.html

5.5 RHN Tools GA Errata
 - http://rhn.redhat.com/errata/RHEA-2012-1299.html

Regards,
Clifford
- Engineering Manager, Satellite