Global functions via Collection level folder?

[russellg]

I am very sorry if this has already been covered. I have found conflicting information online and just want to know if this is an actual available feature or not.

I want to know if it’s possible to have global functions at the Collection level folder (either in the pre-request or tests section) where I can store any functions I use for nearly every test.

For example say for every request I do the following:

console.log(‘hello!’);

could I instead create a function in say the pre-request section at the Collection level:

function hello() {
console.log(‘hello!’)
}

and they for all my requests I could just call hello(); (I know this isn’t a very practical example) but you know what I mean.

I have also tried this via postman.setGlobalVariable but it did not seem to work either.

[vdespa]

Simply defining a function inside the collection pre-request / tests will not make it available everywhere (but it would be nice ) .

The only way I know to reuse code / define it once run it multiple times is to pack the respective function is a Postman variable and when needed to use eval to run it.

Is this what you are looking for?

[russellg]

Hi @vdespa - thanks for your reply. Your suggestion is what I believe my colleague and I ended up doing. I had come back to this thread to provide an update

In the Collection Pre-request script section I add my function(s):

postman.setGlobalVariable("regexFunction", () => {

let regex = /<td>[0-9]{8}<.td>/g;
let regexMatch = bodyResponse.match(regex);
return match[0];
});

Then in my request under Tests:

pageRegex = eval(pm.globals.get("regexFunction"));
pageRegex();

Not the greatest code, but it’s there just to provide context

[pfarrell]

That’s what I do @russellg
I used to have evals() that called a function to send a Slack message if there’s a test failure.

[russellg]

That is on the todo list for sure. Not trying to derail my own thread, but if you have any resources that helped you achieve that I’d like to see them.

[franksunnn110]

The problem had perplexed me for a while until I found the common way mentioned above. However, it still leaves a warning icon for each eval line, which indicates “eval can be harmful” in the postman interface.
Recently, I’ve found another way and post it here:
Users can create a prototype object with the proper function you want in the pre-request script section, like this:

Object.prototype.sayHello = function(name){
    console.log(`Hello! ${name}`);
};

and call that function everywhere after that. It just required a defined object, like this:

let obj = {};
obj.sayHello('Griffin');

Or you don’t even need the declaration of the object but use some built-in objects instead, like lodash (you pretend it has the function )

_.sayHello('Griffin');

It’s working on my side.

[dan.chowdhury]

Fantastic hack! Thanks

[brooke.smith]

However, you don’t seem to be able to set variables (at any scope - maybe global, but that is undesirable) inside such functions. The value is not seen outside.

[rainabba]

Oct. 2020 and I’m dealing with the same. The reason I’m even needing this is to simplify calls like the following with a helper function. Anyone know a more elegant solution or are we still hooking with Object.prototype?

    // The order of function calls below determines the order of precendence
function replaceContext(val) {
    return pm.variables.replaceIn(pm.environment.replaceIn(pm.collectionVariables.replaceIn(val)));
  }

[khuongtbnqa]

It works for me. Thanks for your sharing, Russellg.

[alvaro_mv.co]

@franksunnn110

let obj = {};
obj.sayHello(‘Griffin’);

even this solution works:

utils = {
     sayHello: function (){
       console.log(Hello! ${name});
    }
};

But I have found that pm.environent.set doesn’t work in this function you created if that function is in a collection script, it works if that function is in the request

I can get the variable using pm.environent.get but not set it

Can anyone help on this?

[Tony_Paolucci]

I think this is an issue with scope. I was logging the variable and the pm.environment.get() and both would match but once the execution continued it was gone, This might be a bug. I have a variable that needs to be set in the prerequest. I am trying to get the variable to set so I can reference it in the body with {{variable}}. return and capture it in the request I am able to save it.

collection script:
function (arg){
do something
return arg;

request prerequest script:
variable = obj.function_name(arg)
pm.environment.set();

[rizzorc]

Just ran into a need for this and it worked - thanks for posting this solution !

[ericrommel]

What is the overhead here using all functions in the Collection folder level? For all requests, the functions will be redefined over and over again, doesn’t it?
Example:

• We have 100 functions written at the collection folder level.
• We have 1000 requests

Every time when a request is called, the 100 functions will be redefined.

What do you think about it?

[migmaqer]

Feb 2022 - yeah works well, but noticed i am not getting the eval warnings anymore…thoughts?

[rtfmoz2]

You can do the following at the collection level and it is available under the pm command structure globally without any special declarations.

Collection Level Pre-Request

Object.prototype.log = (msg) => {
    console.info(pm.info.requestName + " | " + msg);
};

User in a Test Script for a Request called “Get User Information”

pm.log("thiis is my log message");

Console

"Get User Information | thiis is my log message"

However all variables are local so if you need something, you need to pass it or use the get/set variable commands to retrieve the values.

Collection Level Pre-Request

Object.prototype.stop = (postman) => {
    postman.setNextRequest(null);
};

Test Script on a Request or Folder.

pm.stop(postman);

If this solves the problem neatly for you please mark is as such. Tested on v9. Glad I can help.

[Rebollo]

Oh my GOOD!
Finally! Thanks a lot!!