Skip to content

Commit 2629235

Browse files
committed
Added new import Postman environments version - V2
1 parent bba6d81 commit 2629235

File tree

1 file changed

+100
-0
lines changed

1 file changed

+100
-0
lines changed

import_postman_env_v2.py

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
#!/usr/bin/env python
2+
"""
3+
Import postman environment file - V2
4+
5+
To set postman environment for existing API target
6+
with Postman collection schema type
7+
8+
"""
9+
import argparse
10+
import json
11+
from urllib.parse import urljoin
12+
import requests
13+
14+
# Define the JWT or it will be asked when you run the script
15+
jwt_token = None
16+
17+
api_base_url = 'https://api.probely.com'
18+
19+
def main():
20+
21+
parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter)
22+
parser.add_argument('-t', '--target', help='Target ID', required=True)
23+
parser.add_argument('-e', '--env-file', help='Environment Variables file', type=argparse.FileType('r'), required=True)
24+
parser.add_argument('--ignore-enabled', help='Ignore enabled property', action='store_true', required=False)
25+
parser.add_argument('--null-to', help='Converts null values to defined value.\n--null-to "null": converts null values to string "null"\n--null-to "": converts null values to empty string (default)', default="", required=False)
26+
parser.add_argument('--include-empty', help='Include empty values', action='store_true', required=False)
27+
args = parser.parse_args()
28+
29+
if jwt_token is None:
30+
token = input("API Token:")
31+
else:
32+
token = jwt_token
33+
34+
if token is None or token == '':
35+
print('Error: JWT is required')
36+
return
37+
headers = {'Authorization': "JWT {}".format(token)}
38+
39+
target_id = args.target
40+
41+
postman_env = json.load(args.env_file)
42+
43+
if "values" not in postman_env or "values" in postman_env and len(postman_env["values"]) == 0:
44+
print("No values on Environment Variables file")
45+
return
46+
47+
parsed_env = []
48+
49+
for item in postman_env["values"]:
50+
51+
if "key" not in item or "value" not in item:
52+
continue
53+
54+
if args.ignore_enabled == False:
55+
if not "enabled" in item or not item["enabled"]:
56+
continue
57+
58+
if "value" in item and item["value"] is None:
59+
item["value"] = args.null_to
60+
61+
if "value" in item and item["value"] == "" and args.include_empty == False:
62+
continue
63+
64+
parsed_env.append({
65+
"name": item["key"],
66+
"value": item["value"]
67+
})
68+
69+
target_endpoint = urljoin(api_base_url, "targets/{target_id}/")
70+
71+
response = requests.get(target_endpoint.format(target_id=target_id), headers=headers)
72+
assert response.status_code == 200, response.json()
73+
74+
custom_api_parameters = (
75+
response.json()["site"]["api_scan_settings"]["custom_api_parameters"] or []
76+
)
77+
78+
updated_field_names = [entry["name"] for entry in parsed_env]
79+
80+
custom_api_parameters = [
81+
*[
82+
entry
83+
for entry in custom_api_parameters
84+
if entry["name"] not in updated_field_names
85+
],
86+
*parsed_env,
87+
]
88+
89+
response = requests.patch(
90+
target_endpoint.format(target_id=target_id),
91+
headers=headers,
92+
json={
93+
"site": {"api_scan_settings": {"custom_api_parameters": custom_api_parameters}}
94+
},
95+
)
96+
assert response.status_code == 200, response.json()
97+
98+
if __name__ == '__main__':
99+
main()
100+
print("Done.")

0 commit comments

Comments
 (0)