def test_get_results_from_log_file_specific_function(
fx_copy_fn_main_mock_integration, fx_cmd_line_args_codegen_base,
fx_get_sub_parser, caplog):
mock_integration_name = fx_copy_fn_main_mock_integration[0]
path_fn_main_mock_integration = fx_copy_fn_main_mock_integration[1]
# Replace cmd line arg "fn_main_mock_integration" with path to temp dir location
sys.argv[sys.argv.index(
mock_integration_name)] = path_fn_main_mock_integration
# Add arg to gather-results
sys.argv.extend(["--gather-results", mock_paths.MOCK_APP_LOG_PATH])
sys.argv.extend(["-f", "mock_function_one", "mock_function_not_exist"])
cmd_codegen = CmdCodegen(fx_get_sub_parser)
args = cmd_codegen.parser.parse_known_args()[0]
cmd_codegen.execute_command(args)
path_payload_samples = os.path.join(
path_fn_main_mock_integration,
package_helpers.BASE_NAME_PAYLOAD_SAMPLES_DIR)
# Test output_json_example.json file generated
output_json_example_contents = sdk_helpers.read_json_file(
os.path.join(path_payload_samples, "mock_function_one",
package_helpers.BASE_NAME_PAYLOAD_SAMPLES_EXAMPLE))
assert output_json_example_contents.get("version") == 2.1
# Test output_json_schema.json file generated
output_json_example_schema = sdk_helpers.read_json_file(
os.path.join(path_payload_samples, "mock_function_one",
package_helpers.BASE_NAME_PAYLOAD_SAMPLES_SCHEMA))
output_json_example_schema_props = output_json_example_schema.get(
"properties")
assert output_json_example_schema_props.get("version") == {
"type": "number"
}
assert output_json_example_schema_props.get("success") == {
"type": "boolean"
}
assert output_json_example_schema_props.get("reason") == {}
assert not output_json_example_schema.get("required")
# Test WARNING log appears
assert "WARNING: No results could be found for 'mock_function_not_exist'" in caplog.text
def test_get_results_from_log_file_no_payload_samples_dir(
fx_copy_fn_main_mock_integration, fx_cmd_line_args_codegen_base,
fx_get_sub_parser, caplog):
mock_integration_name = fx_copy_fn_main_mock_integration[0]
path_fn_main_mock_integration = fx_copy_fn_main_mock_integration[1]
# Replace cmd line arg "fn_main_mock_integration" with path to temp dir location
sys.argv[sys.argv.index(
mock_integration_name)] = path_fn_main_mock_integration
# Add arg to gather-results and a path to a mock export.res file for --reload
sys.argv.extend(["--gather-results", mock_paths.MOCK_APP_LOG_PATH])
sys.argv.extend(["-e", mock_paths.MOCK_RELOAD_EXPORT_RES])
path_payload_samples = os.path.join(
path_fn_main_mock_integration,
package_helpers.BASE_NAME_PAYLOAD_SAMPLES_DIR)
# Remove path_payload_samples
shutil.rmtree(path_payload_samples)
cmd_codegen = CmdCodegen(fx_get_sub_parser)
args = cmd_codegen.parser.parse_known_args()[0]
cmd_codegen.execute_command(args)
# Test output_json_example.json file generated
output_json_example_contents = sdk_helpers.read_json_file(
os.path.join(path_payload_samples, "mock_function_one",
package_helpers.BASE_NAME_PAYLOAD_SAMPLES_EXAMPLE))
assert output_json_example_contents.get("version") == 2.1
# Test output_json_schema.json file generated
output_json_example_schema = sdk_helpers.read_json_file(
os.path.join(path_payload_samples, "mock_function_one",
package_helpers.BASE_NAME_PAYLOAD_SAMPLES_SCHEMA))
output_json_example_schema_props = output_json_example_schema.get(
"properties")
assert output_json_example_schema_props.get("version") == {
"type": "number"
}
assert output_json_example_schema_props.get("reason") == {}
# Test --reload was ran
assert "Running 'codegen --reload' to create the default missing files" in caplog.text
def get_import_definition_from_local_export_res(path_export_res_file):
"""Return ImportDefinition from a local (/util/data) export.res file as a Dictionary"""
# Read /util/data/export.res file
import_definition = sdk_helpers.read_json_file(path_export_res_file)
# Remove the incident type that was added by codegen that allows the data to import
import_definition = remove_default_incident_type_from_import_definition(import_definition)
return import_definition
def create_extension(path_setup_py_file, path_apikey_permissions_file,
output_dir, path_built_distribution=None, path_extension_logo=None, path_company_logo=None, path_payload_samples=None, path_validate_report=None,
custom_display_name=None, repository_name=None, image_hash=None, keep_build_dir=False):
"""
Function that creates The App.zip file from the given setup.py, customize and config files
and copies it to the output_dir. Returns the path to the app.zip
:param path_setup_py_file: abs path to the setup.py file
:type path_setup_py_file: str
:param path_apikey_permissions_file: abs path to the apikey_permissions.txt file
:type path_apikey_permissions_file: str
:param output_dir: abs path to the directory the App.zip should be produced
:type output_dir: str
:param path_built_distribution: abs path to a tar.gz Built Distribution
- if provided uses that .tar.gz
- else looks for it in the output_dir. E.g: output_dir/package_name.tar.gz
:type path_built_distribution: str
:param path_extension_logo: abs path to the app_logo.png. Has to be 200x72 and a .png file
- if not provided uses default icon
:type path_extension_logo: str
:param path_company_logo: abs path to the company_logo.png. Has to be 100x100 and a .png file
- if not provided uses default icon
:type path_company_logo: str
:param path_payload_samples: abs path to directory containing the files with a JSON schema and example output of the functions
:type path_payload_samples: str
:param path_validate_report: abs path to directory containing the validation report - to be copied to the build directory that will be zipped
:type path_validate_report: str
:param custom_display_name: will give the App that display name. Default: name from setup.py file
:type custom_display_name: str
:param repository_name: will over-ride the container repository name for the App. Default: 'ibmresilient'
:type repository_name: str
:param image_hash: if defined will append the hash to the image_name in the app.json file e.g. <repository_name>/<package_name>@sha256:<image_hash>. Default: <repository_name>/<package_name>:<version>
:type image_hash: str
:param keep_build_dir: if True, build/ will not be removed. Default: False
:type keep_build_dir: bool
:return: Path to new app.zip
:rtype: str
"""
LOG.info("Creating App")
# Variables to hold path of files for customize and config as defined in setup.py.
# Set initially default to 'None', actual paths will be calculated later.
path_customize_py_file = None
path_config_py_file = None
# Ensure the output_dir exists, we have WRITE access and ensure we can READ setup.py and apikey_permissions.txt
# files.
sdk_helpers.validate_dir_paths(os.W_OK, output_dir)
sdk_helpers.validate_file_paths(os.R_OK, path_setup_py_file, path_apikey_permissions_file)
# Parse the setup.py file
setup_py_attributes = parse_setup_py(path_setup_py_file, SUPPORTED_SETUP_PY_ATTRIBUTE_NAMES)
# Validate setup.py attributes
# Validate the name attribute. Raise exception if invalid
if not sdk_helpers.is_valid_package_name(setup_py_attributes.get("name")):
raise SDKException("'{0}' is not a valid App name. The name attribute must be defined and can only include 'a-z and _'.\nUpdate this value in the setup.py file located at: {1}".format(setup_py_attributes.get("name"), path_setup_py_file))
# Validate the version attribute. Raise exception if invalid
if not sdk_helpers.is_valid_version_syntax(setup_py_attributes.get("version")):
raise SDKException("'{0}' is not a valid App version syntax. The version attribute must be defined. Example: version=\"1.0.0\".\nUpdate this value in the setup.py file located at: {1}".format(setup_py_attributes.get("version"), path_setup_py_file))
# Validate the url supplied in the setup.py file, set to an empty string if not valid
if not sdk_helpers.is_valid_url(setup_py_attributes.get("url")):
LOG.warning("WARNING: '%s' is not a valid url. Ignoring.", setup_py_attributes.get("url"))
setup_py_attributes["url"] = ""
# Get the tag name
tag_name = setup_py_attributes.get("name")
# Get the customize file location.
path_customize_py_file = get_configuration_py_file_path("customize", setup_py_attributes)
# Get the config file location.
path_config_py_file = get_configuration_py_file_path("config", setup_py_attributes)
# Get ImportDefinition from the discovered customize file.
if path_customize_py_file:
import_definition = get_import_definition_from_customize_py(path_customize_py_file)
else:
# No 'customize.py' file found generate import definition with just mimimum server version.
import_definition = {
'server_version':
IMPORT_MIN_SERVER_VERSION
}
# Add the tag to the import defintion
import_definition = add_tag_to_import_definition(tag_name, SUPPORTED_RES_OBJ_NAMES, import_definition)
# Parse the app.configs from the discovered config file
if path_config_py_file:
app_configs = get_configs_from_config_py(path_config_py_file)
else:
# No config file file found generate an empty definition.
app_configs = ("", [])
# Parse the api key permissions from the apikey_permissions.txt file
apikey_permissions = get_apikey_permissions(path_apikey_permissions_file)
# Generate the name for the extension
extension_name = "{0}-{1}".format(setup_py_attributes.get("name"), setup_py_attributes.get("version"))
# Generate the uuid
uuid = sdk_helpers.generate_uuid_from_string(setup_py_attributes.get("name"))
# Set the container repository name to default if value not passed in as argument.
if not repository_name:
repository_name = REPOSITORY_NAME
# Generate paths to the directories and files we will use in the build directory
path_build = os.path.join(output_dir, BASE_NAME_BUILD)
path_extension_json = os.path.join(path_build, BASE_NAME_EXTENSION_JSON)
path_export_res = os.path.join(path_build, BASE_NAME_EXPORT_RES)
try:
# If there is an old build directory, remove it first
if os.path.exists(path_build):
shutil.rmtree(path_build)
# Create the directories for the path "/build/"
os.makedirs(path_build)
# If no path_built_distribution is given, use the default: "<output_dir>/<package-name>.tar.gz"
if not path_built_distribution:
path_built_distribution = os.path.join(output_dir, "{0}.tar.gz".format(extension_name))
# Validate the built distribution exists and we have READ access
sdk_helpers.validate_file_paths(os.R_OK, path_built_distribution)
# Copy the built distribution to the build dir and enforce rename to .tar.gz
shutil.copy(path_built_distribution, os.path.join(path_build, "{0}.tar.gz".format(extension_name)))
# Get the extension_logo (icon) and company_logo (author.icon) as base64 encoded strings
extension_logo = get_icon(
icon_name=os.path.basename(PATH_DEFAULT_ICON_EXTENSION_LOGO),
path_to_icon=path_extension_logo,
width_accepted=constants.ICON_APP_LOGO_REQUIRED_WIDTH,
height_accepted=constants.ICON_APP_LOGO_REQUIRED_HEIGHT,
default_path_to_icon=PATH_DEFAULT_ICON_EXTENSION_LOGO)
company_logo = get_icon(
icon_name=os.path.basename(PATH_DEFAULT_ICON_COMPANY_LOGO),
path_to_icon=path_company_logo,
width_accepted=constants.ICON_COMPANY_LOGO_REQUIRED_WIDTH,
height_accepted=constants.ICON_COMPANY_LOGO_REQUIRED_HEIGHT,
default_path_to_icon=PATH_DEFAULT_ICON_COMPANY_LOGO)
# Get the display name
# Use --display-name if passed
# If not use 'display_name' attribute in setup.py
# If not set use the 'name' attribute in setup.py
display_name = custom_display_name or setup_py_attributes.get("display_name") or setup_py_attributes.get("name")
# Image string is all lowercase on quay.io
image_name = "{0}/{1}:{2}".format(repository_name, setup_py_attributes.get("name"), setup_py_attributes.get("version"))
if image_hash:
if not sdk_helpers.is_valid_hash(image_hash):
raise SDKException(u"image_hash '{0}' is not a valid SHA256 hash\nIt must be a valid hexadecimal and 64 characters long".format(image_hash))
# If image_hash is defined append to image name e.g. <repository_name>/<package_name>@sha256:<image_hash>
image_name = "{0}/{1}@sha256:{2}".format(repository_name, setup_py_attributes.get("name"), image_hash)
image_name = image_name.lower()
LOG.debug("image_name generated: %s", image_name)
# Generate the contents for the extension.json file
the_extension_json_file_contents = {
"author": {
"name": setup_py_attributes.get("author"),
"website": setup_py_attributes.get("url"),
"icon": {
"data": company_logo,
"media_type": "image/png"
}
},
"description": {
"content": setup_py_attributes.get("description"),
"format": "text"
},
"display_name": display_name,
"icon": {
"data": extension_logo,
"media_type": "image/png"
},
"long_description": {
"content": u"<div>{0}</div>".format(setup_py_attributes.get("long_description")),
"format": "html"
},
"minimum_resilient_version": {
"major": import_definition.get("server_version").get("major", None),
"minor": import_definition.get("server_version").get("minor", None),
"build_number": import_definition.get("server_version").get("build_number", None),
"version": import_definition.get("server_version").get("version", None)
},
"name": setup_py_attributes.get("name"),
"tag": {
"prefix": tag_name,
"name": tag_name,
"display_name": tag_name,
"uuid": uuid
},
"uuid": uuid,
"version": setup_py_attributes.get("version"),
"current_installation": {
"executables": [
{
"name": setup_py_attributes.get("name"),
"image": image_name,
"config_string": app_configs[0],
"permission_handles": apikey_permissions,
"uuid": uuid
}
]
}
}
# Write the executable.json file
sdk_helpers.write_file(path_extension_json, json.dumps(the_extension_json_file_contents, sort_keys=True))
# Gather payload_samples file for each function and add to export.res file if exists
if not path_payload_samples:
LOG.warning("WARNING: No path for 'payload_samples' provided. Skipping adding them to the export.res file")
else:
for fn in import_definition.get("functions"):
# Get paths to payload_samples
fn_name = fn.get(ResilientObjMap.FUNCTIONS)
path_payload_samples_fn = os.path.join(path_payload_samples, fn_name)
path_payload_samples_schema = os.path.join(path_payload_samples_fn, BASE_NAME_PAYLOAD_SAMPLES_SCHEMA)
path_payload_samples_example = os.path.join(path_payload_samples_fn, BASE_NAME_PAYLOAD_SAMPLES_EXAMPLE)
try:
# Validate payload_files, add custom error message if we can't
sdk_helpers.validate_file_paths(os.R_OK, path_payload_samples_schema, path_payload_samples_example)
except SDKException as err:
err.message += ("\nWARNING: could not access JSON file to add payload_samples. Continuing to create package.\n"
"Add '--no-samples' flag to avoid looking for them and avoid this warning message.\n")
LOG.warning(err.message)
continue
# Read in schema payload and add to function import definition
payload_samples_schema_contents_dict = sdk_helpers.read_json_file(path_payload_samples_schema)
LOG.debug("Adding JSON output schema to '%s' from file: %s", fn_name, path_payload_samples_schema)
json_schema_key = os.path.splitext(BASE_NAME_PAYLOAD_SAMPLES_SCHEMA)[0]
fn[json_schema_key] = json.dumps(payload_samples_schema_contents_dict)
# Read in example payload and add to function import definition
payload_samples_example_contents_dict = sdk_helpers.read_json_file(path_payload_samples_example)
LOG.debug("Adding JSON output example to '%s' from file: %s", fn_name, path_payload_samples_example)
json_example_key = os.path.splitext(BASE_NAME_PAYLOAD_SAMPLES_EXAMPLE)[0]
fn[json_example_key] = json.dumps(payload_samples_example_contents_dict)
if path_validate_report:
path_zipped_validate_report = os.path.join(path_build, os.path.basename(path_validate_report))
shutil.copy(path_validate_report, path_zipped_validate_report)
else:
LOG.warn("WARNING: If a validation report is not included with your submission, it will get rejected. Run this command with the '--validate' flag to include validations.")
# Write the customize ImportDefinition to the app*.zip export.res file
sdk_helpers.write_file(path_export_res, json.dumps(import_definition, sort_keys=True))
# Copy the built distribution to the build dir, enforce rename to .tar.gz
shutil.copy(path_built_distribution, os.path.join(path_build, "{0}.tar.gz".format(extension_name)))
# Create the app.zip (Extension Zip) by zipping the build directory
extension_zip_base_path = os.path.join(output_dir, "{0}{1}".format(PREFIX_EXTENSION_ZIP, extension_name))
extension_zip_name = shutil.make_archive(base_name=extension_zip_base_path, format="zip", root_dir=path_build)
path_the_extension_zip = os.path.join(extension_zip_base_path, extension_zip_name)
except SDKException as err:
raise err
except Exception as err:
raise SDKException(err)
finally:
# Remove the build dir. Keep it if user passes --keep-build-dir
if not keep_build_dir:
shutil.rmtree(path_build)
LOG.info("App %s.zip created", "{0}{1}".format(PREFIX_EXTENSION_ZIP, extension_name))
# Return the path to the extension zip
return path_the_extension_zip
def execute_command(self, args):
LOG.debug("docgen called with %s", args)
# Set docgen name for SDKException
SDKException.command_ran = self.CMD_NAME
# Get absolute path_to_src
path_to_src = os.path.abspath(args.p)
LOG.debug("Path to project: %s", path_to_src)
# Instansiate Jinja2 Environment with path to Jinja2 templates
jinja_env = sdk_helpers.setup_jinja_env("data/docgen/templates")
# Load the Jinja2 Templates
readme_template = jinja_env.get_template(README_TEMPLATE_NAME)
# Generate path to setup.py file
path_setup_py_file = os.path.join(path_to_src,
package_helpers.BASE_NAME_SETUP_PY)
try:
# Ensure we have read permissions for setup.py
sdk_helpers.validate_file_paths(os.R_OK, path_setup_py_file)
except SDKException as err:
err.message += "\nEnsure you are in the directory of the package you want to run docgen for"
raise err
# Parse the setup.py file
setup_py_attributes = package_helpers.parse_setup_py(
path_setup_py_file,
package_helpers.SUPPORTED_SETUP_PY_ATTRIBUTE_NAMES)
package_name = setup_py_attributes.get("name", "")
# Generate paths to other required directories + files
path_customize_py_file = os.path.join(
path_to_src, package_name, package_helpers.PATH_CUSTOMIZE_PY)
path_config_py_file = os.path.join(path_to_src, package_name,
package_helpers.PATH_CONFIG_PY)
path_readme = os.path.join(path_to_src,
package_helpers.BASE_NAME_README)
path_screenshots_dir = os.path.join(path_to_src,
package_helpers.PATH_SCREENSHOTS)
path_payload_samples_dir = os.path.join(
path_to_src, package_helpers.BASE_NAME_PAYLOAD_SAMPLES_DIR)
# Ensure we have read permissions for each required file and the file exists
sdk_helpers.validate_file_paths(os.R_OK, path_setup_py_file,
path_customize_py_file,
path_config_py_file)
# Check doc/screenshots directory exists, if not, create it + copy default screenshot
if not os.path.isdir(path_screenshots_dir):
os.makedirs(path_screenshots_dir)
shutil.copy(package_helpers.PATH_DEFAULT_SCREENSHOT,
path_screenshots_dir)
# Get the resilient_circuits dependency string from setup.py file
res_circuits_dep_str = package_helpers.get_dependency_from_install_requires(
setup_py_attributes.get("install_requires"), "resilient_circuits")
if not res_circuits_dep_str:
res_circuits_dep_str = package_helpers.get_dependency_from_install_requires(
setup_py_attributes.get("install_requires"),
"resilient-circuits")
# Get ImportDefinition from customize.py
customize_py_import_def = package_helpers.get_import_definition_from_customize_py(
path_customize_py_file)
# Parse the app.configs from the config.py file
jinja_app_configs = package_helpers.get_configs_from_config_py(
path_config_py_file)
# Get field names from ImportDefinition
field_names = []
for f in customize_py_import_def.get("fields", []):
f_export_key = f.get("export_key")
if "incident/" in f_export_key and f_export_key not in IGNORED_INCIDENT_FIELDS:
field_names.append(f.get(ResilientObjMap.FIELDS, ""))
# Get data from ImportDefinition
import_def_data = sdk_helpers.get_from_export(
customize_py_import_def,
message_destinations=sdk_helpers.get_object_api_names(
ResilientObjMap.MESSAGE_DESTINATIONS,
customize_py_import_def.get("message_destinations")),
functions=sdk_helpers.get_object_api_names(
ResilientObjMap.FUNCTIONS,
customize_py_import_def.get("functions")),
workflows=sdk_helpers.get_object_api_names(
ResilientObjMap.WORKFLOWS,
customize_py_import_def.get("workflows")),
rules=sdk_helpers.get_object_api_names(
ResilientObjMap.RULES, customize_py_import_def.get("actions")),
fields=field_names,
artifact_types=sdk_helpers.get_object_api_names(
ResilientObjMap.INCIDENT_ARTIFACT_TYPES,
customize_py_import_def.get("incident_artifact_types")),
datatables=sdk_helpers.get_object_api_names(
ResilientObjMap.DATATABLES,
customize_py_import_def.get("types")),
tasks=sdk_helpers.get_object_api_names(
ResilientObjMap.TASKS,
customize_py_import_def.get("automatic_tasks")),
scripts=sdk_helpers.get_object_api_names(
ResilientObjMap.SCRIPTS,
customize_py_import_def.get("scripts")),
playbooks=sdk_helpers.get_object_api_names(
ResilientObjMap.PLAYBOOKS,
customize_py_import_def.get("playbooks", [])))
# Lists we use in Jinja Templates
jinja_functions = self._get_function_details(
import_def_data.get("functions", []),
import_def_data.get("workflows", []))
jinja_scripts = self._get_script_details(
import_def_data.get("scripts", []))
jinja_rules = self._get_rule_details(import_def_data.get("rules", []))
jinja_datatables = self._get_datatable_details(
import_def_data.get("datatables", []))
jinja_custom_fields = self._get_custom_fields_details(
import_def_data.get("fields", []))
jinja_custom_artifact_types = self._get_custom_artifact_details(
import_def_data.get("artifact_types", []))
jinja_playbooks = self._get_playbook_details(
import_def_data.get("playbooks", []))
# Other variables for Jinja Templates
package_name_dash = package_name.replace("_", "-")
server_version = customize_py_import_def.get("server_version", {})
supported_app = sdk_helpers.does_url_contain(
setup_py_attributes.get("url", ""), "ibm.com/mysupport")
# See if a payload_samples dir exists and use the contents for function results
try:
sdk_helpers.validate_dir_paths(os.R_OK, path_payload_samples_dir)
for f in jinja_functions:
fn_name = f.get("x_api_name")
path_payload_samples_fn_name = os.path.join(
path_payload_samples_dir, fn_name)
path_output_json_example = os.path.join(
path_payload_samples_fn_name,
package_helpers.BASE_NAME_PAYLOAD_SAMPLES_EXAMPLE)
try:
sdk_helpers.validate_file_paths(os.R_OK,
path_output_json_example)
f["results"] = sdk_helpers.read_json_file(
path_output_json_example)
except SDKException as e:
sdk_helpers.handle_file_not_found_error(
e,
u"Error getting results. No '{0}' file found for '{1}'."
.format(
package_helpers.BASE_NAME_PAYLOAD_SAMPLES_EXAMPLE,
fn_name))
except SDKException as e:
sdk_helpers.handle_file_not_found_error(
e, u"Error getting results. No '{0}' directory found.".format(
package_helpers.BASE_NAME_PAYLOAD_SAMPLES_EXAMPLE))
LOG.info("Rendering README for %s", package_name_dash)
# Render the README Jinja2 Templeate with parameters
rendered_readme = readme_template.render({
"name_underscore":
package_name,
"name_dash":
package_name_dash,
"display_name":
setup_py_attributes.get("display_name", package_name),
"short_description":
setup_py_attributes.get("description"),
"long_description":
setup_py_attributes.get("long_description"),
"version":
setup_py_attributes.get("version"),
"server_version":
server_version.get("version"),
"all_dependencies":
setup_py_attributes.get("install_requires", []),
"res_circuits_dependency_str":
res_circuits_dep_str,
"author":
setup_py_attributes.get("author"),
"support_url":
setup_py_attributes.get("url"),
"supported_app":
supported_app,
"app_configs":
jinja_app_configs[1],
"functions":
jinja_functions,
"scripts":
jinja_scripts,
"rules":
jinja_rules,
"datatables":
jinja_datatables,
"custom_fields":
jinja_custom_fields,
"custom_artifact_types":
jinja_custom_artifact_types,
"playbooks":
jinja_playbooks,
"placeholder_string":
constants.DOCGEN_PLACEHOLDER_STRING
})
# Create a backup if needed of README
sdk_helpers.rename_to_bak_file(path_readme,
package_helpers.PATH_DEFAULT_README)
LOG.info("Writing README to: %s", path_readme)
# Write the new README
sdk_helpers.write_file(path_readme, rendered_readme)
def test_read_json_file(fx_mk_temp_dir):
export_data = sdk_helpers.read_json_file(mock_paths.MOCK_EXPORT_RES)
assert isinstance(export_data, dict)
assert "functions" in export_data