Run a given file with a set of input variable values?

[natalie-o-perret]

🙋‍♀️ Hello,

So here is below a file I'm using, and I would like to create a test suite that would run different values of @inputVariable, is there a way to achieve that with the latest version of httpyac?

What I'm usually doing is running Get Stuff From Api 7 (since it references everything else) and the piece of js script at the bottom runs right after the Get Stuff From Api 7 execution which allows to fetch every other request referenced by Get Stuff From Api 7 and Get Stuff From Api 7 itsef to be used in the script.

That being said, it's get a bit tedious when I need to run with set of values for the same @inputVariable.

Eventually, I'd like to write expect's for each value for the @inputVariable.

If so, how? (been through the docs, can't find something that would allow running a same file with different value for the @inputVariable.

@inputVariable = xxx

### Get Stuff From Api 1
# @name getStuffFromApi1
@apiParam1=200
@apiParam2=1
GET {{api1Host}}/api/api-version/resource?query-string-param1={{inputVariable}}&query-string-param2=true
Authorization: openid client_credentials apiSso

### Get Stuff From Api 2
# @name getStuffFromApi2
# @forceRef getStuffFromApi1
{{ 
  exports.ids=getStuffFromApi1.results.map(x => `ids=${x.idField}`).join('&')
}}
GET {{api2Host}}/api-version/resource?{{ids}}
Authorization: openid client_credentials apiSso

### Get Stuff From Api 3
# @name getStuffFromApi3
# @forceRef getStuffFromApi1
{{ 
  exports.ids=getStuffFromApi1.results.map(x => `ids=${x.idField}`).join('&')
}}
GET {{api3Host}}/api-version/resource?{{ids}}
Authorization: openid client_credentials apiSso

### Get Stuff From Api 4
# @name getStuffFromApi4
GET {{api4Host}}/api-version/resource?query-string-param={{inputVariable}}
Authorization: openid client_credentials apiSso 

### Get Stuff From Api 5
# @name getStuffFromApi5
POST {{api5Host}}/api-version/resource
Authorization: openid client_credentials apiSso
Content-Type: application/json
{
  "someField1": [ "{{inputVariable }}" ],
  "someField2": false
}

### Get Stuff From Api 6
# @name getStuffFromApi6
GET {{api6Host}}/api-version/resource?query-string-param={{inputVariable}}
Authorization: openid client_credentials apiSso

### Get Stuff From Api 7
# @name getStuffFromApi7
# @forceRef getStuffFromApi2
# @forceRef getStuffFromApi3
# @forceRef getStuffFromApi4
# @forceRed getStuffFromApi5
# @forceRef getStuffFromApi6
POST {{api7Host}}/api/api-version/resource
Authorization: openid client_credentials apiSso
Content-Type: application/json
{ "someField": "{{inputVariable }}" }


{{
  const fs = require('fs');
  const readline = require('readline');
  const path = require('path');

  const csvFilePath = path.join(__dirname, 'mapping.csv');
  const stream = fs.createReadStream(csvFilePath);
  stream.on('error', (err) => { console.error("Error reading file:", err); });
  const rl = readline.createInterface({ input: stream });
  const csvMapping = {};
  rl.on('line', (line) => {
    let [,b,, d] = line.split(',');
    csvMapping[b] = d;
  }).on('close', () => {
    const formatDate = (date) =>
      `${date.getDate().toString().padStart(2, '0')}/${(date.getMonth() + 1)
        .toString()
        .padStart(2, '0')}/${date.getFullYear()}`;

    console.info(`Input Variable: ${inputVariable}`);

    const entities2 = getStuffFromApi2.results
      .reduce((dict, x) => (dict[x.someField] = x, dict), {});
    
    const entities3 = getStuffFromApi3.results
      .reduce((dict, x) => (dict[x.someField] = x, dict), {});
    
    const entities6 = getStuffFromApi6.results
      .filter(x => x.someField1 === "someValue1" 
                && x.someField2 === "someValue2")
      .reduce((dict, x) => (dict[x.someField] = x, dict), {});

    for (let i = 0; i < getStuffFromApi1.results.length; i++) {
      const entity1 = getStuffFromApi1.results[i];
      const entity2 = entities2[entity1.someField];
      const value01 = entity1.someField1;
      const entity6 = entities6[entity2 ];
      const value09 = entities3[entity1.someField].name;
      const value02 = entity1.someOtherField;
      const value03 = entity1.yetAnotherField;
      const value10 = entity2.name;
      const value11 = csvMapping[value10];
      const thatEntity = getStuffFromApi7.results.filter(x => x.someField === value1)[0];
      const value12 = thatEntity.results.filter(x => x.roles.includes("someValue1"))[0].someField;
      const value13 = thatEntity.results.filter(x => x.roles.includes("someValue2"))[0].someField;
      const value14 = thatEntity.results.filter(x => x.roles.includes("someValue3"))[0].someField;
      const value15 = entity6
       ? formatDate(new Date(entity6.someField))
       : "n/a";

      const value04 = entity1.someField1.someField1;
      const value05 = entity1.someField1.someField2;
      const value06 = entity1.someField1.someField3;
      const value07 = entity1.someField1.someField4;
      const value08 = entity1.someField2;


      console.info(`- [Team A - Api1] Value 01: ${value01}`);
      console.info(`  - [Team A - Api1] Value 02: ${value02}`);
      console.info(`  - [Team A - Api1] Value 03: ${value03}`);
      console.info(`  - [Team A - Api1] Value 04: ${value04}`);
      console.info(`  - [Team A - Api1] Value 05: ${value05 ? value05 * 100 + "%" : "n/a"}`);
      console.info(`  - [Team A - Api1] Value 06: ${value06}`);
      console.info(`  - [Team A - Api1] Value 07: ${value07 ? value07 * 100 + "%" : "n/a"}`);  
      console.info(`  - [Team A - Api1] Value 08: ${value08}`);
      console.info(`  - [Team A - Api2] Value 09: ${value09}`);
      console.info(`  - [Team A - Api3] Value 10: ${value10}`);
      console.info(`  - [Team A - Api3] Value 11: ${value11}`);

      console.info(`  - [Team B - Api7] Value 12: ${value12}`);
      console.info(`  - [Team B - Api7] Value 13: ${value13}`);
      console.info(`  - [Team B - Api7] Value 14: ${value14}`);
      console.info(`  - [Team B - Api6] Value 15: ${value15}`);  

      console.info(`  - [Team B - Api5] Value 16: ${value16}`);
      console.info(`  - [Team B - Api5] Value 17: ${value17}`);
    }
  });
}}

[AnWeber]

Does using environments not work? https://httpyac.github.io/guide/environments.html

[natalie-o-perret]

Well, I am already using the environments but they are more about the baseUrl, sso client, secrets, etc. (e.g., integration, staging, production).

But they don't fit the bill if I need like 15 different values for @inputVariable (akin to test cases with different expect).

[AnWeber]

I would have provided loop for tests with different arguments for the same interface. But you can still combine this with @ref, which I personally don't like. Initialized variables are passed at $ref and thus more or less correspond to a function call. You could also use this to write a loop of tests. The only problem is that the region can also be called without the initialization. Either you cancel the region or make a fallback

# @name loop tests
{{
  exports.tests = [{
    param: "foo",
    result: `"foo": "foo"`
  },{
    param: "bar",
    result: `"foo": "bar"`
  }]
}}
# @loop for testItem of tests

# @forceRef testRun

###
# @name testRun

{{
  if(!this["testItem"){
   exports.testItem = {param: "foo", result: "foo"};
  }
  // exports.$cancel = !this["testItem"] // cancel region
}}
POST https://postman-echo.com/post

{
  "foo": "{{testItem.param}}"
}

?? body contains {{testItem.result}}