Forum Discussion

JoostDG's avatar
JoostDG
Frequent Contributor
4 years ago

How to make swagger compliance assertion url dynamic

Hi, I have been struggling to get some grip on the swagger compliance assertion. I want to provide a dynamic url but ReadyAPI doesn't seem to cope with it in the way I would expect. Use case: The s...
Assertions
  • nmrao's avatar
    nmrao
    4 years ago

    JoostDG 

    Here is an approach which you can try.

    NOTE:

    1. In the Swagger Compliance Assertion set a file path or url (absolute value). The value will be replaced with value passed at run time as project property, SWAGGER_URL

    2. Here, property expansion is not used. Instead value is overridden run time.

    3. Please follow the comments provided in the script.

    4. This is project setup script only.

     

    Project Setup Script 

    Here is the log message when the script is run

     

     

JoostDG's avatar
JoostDG
Frequent Contributor

Me again... not trying to make a habit of replying to my own posts to much... but for the sake of being transparent:

Path1 mentioned above, which is a relative path pointing to a yaml file present in my project repo, DOES NOT WORK when run on a Linux machine. The swagger validation assertion url \${#Project#swaggerENGvalidationPath} works on windows, but on linux he can't find that path. Tried double escaping like this \\${#Project#swaggerENGvalidationPath} but nope... 

 

So close... 

 

For now I disabled those swagger validations assertions if the OS is linux via the ReadyTools.isLinux()  (import com.smartbear.ready.util.ReadyTools).

nmrao's avatar
nmrao
Champion Level 3
4 years ago
What is the value of "testDataPath" in both OS'es?
  • JoostDG's avatar
    JoostDG
    Frequent Contributor
    4 years ago

    Via project setup script:

    import java.io.File

    def testDataPath = project.path + File.separator + "datasource"

    def swaggerENGversionForValidation = "swaggerMyApplicationV1.2.3"

    def swaggerENGvalidationPath = testDataPath + File.separator + "swagger" + File.separator + "ENG" + File.separator + swaggerENGversionForValidation + ".yaml"

     

    So the actual full path for swaggerENGvalidationPath is for example on windows: C:\git\automated-api-tests\myReadyApiProject\datasource\swagger\ENG\swaggerMyApplicationV1.2.3.yaml. This way of defining the path works, as I successfully use it in my script library. Also on Linux it can find the other files in my datasource folder when I call upon it in a script. But it's just the way the swagger validation assertion input transforms the "url" I provide in there that makes it goes wrong.

     

    From linux logs : ASSERTION FAILED -> Swagger Compliance check failed: [Could not find file:

    •  A url like this \${#Project#swaggerENGvalidationPath} goes to:

    /linux/folders/bamboo/agent-1/xml-data/build-dir/TEST/%5C//linux/folders/bamboo/agent-1/xml-data/build-dir/TEST/myReadyApiProject/datasource/swagger/ENG/swaggerMyApplicationV1.2.3.yaml

    • A url like this \\${#Project#swaggerENGvalidationPath} goes to:

    /linux/folders/bamboo/agent-1/xml-data/build-dir/TEST/%5C%5C/linux/folders/bamboo/agent-1/xml-data/build-dir/TEST/myReadyApiProject/datasource/swagger/ENG/swaggerMyApplicationV1.2.3.yaml.

     

    Both work on windows.

    • nmrao's avatar
      nmrao
      Champion Level 3
      4 years ago

      JoostDG 

      I would use something like below to build the path, more of a convenient. +, " little noisy.

       

       

      def SEP = File.separator
def swaggerENGvalidationPath = "${testDataPath}${SEP}swagger${SEP}ENG${SEP}${swaggerENGversionForValidation}.yaml"

       

       

      In the assertion, just use below.  No "\"  are required as prefix.

      ${#Project#swaggerENGvalidationPath} 

       

      If the above does not help, then just try to log  and see the path is correct.

      log.info ${testDataPath}

      • JoostDG's avatar
        JoostDG
        Frequent Contributor
        4 years ago

        Hi Rao.

        Thanks for the suggestions, but when I define it like you say and assert against ${#Project#swaggerENGvalidationPath}  (without \) I get below error on Windows: illegalArgumentException: input "#" is not an absolute JSON Reference. That's the same error I got for my initial attempts when I left out the backslash. 

        I tried to include the "\" into the path itself like this project.setPropertyValue("swaggerENGvalidationPath", "\\"+swaggerENGvalidationPath) and this project.setPropertyValue("swaggerENGvalidationPath", "\\\\"+swaggerENGvalidationPath), but always the same error. It looks like a \ is needed but that only works on windows. Haven't tried on linux yet, but idea is to have a working solution in both OSs.

        I can't put code in the url assertion, otherwise I'd try to do there an "if (!isLinux() ) { add a \ in front of the swaggerENGvalidationPath } else { no \}

         

        Would be nice if there would be a possibility to do a "get data" in this assertions like in many others, so it's easy to point to a relative path instead of an absolute url.