Skip to content

Commit

Permalink
Adsk Contrib - Improve the context variable validation (#1387) (#1395)
Browse files Browse the repository at this point in the history 
Signed-off-by: Patrick Hodoul <Patrick.Hodoul@autodesk.com>
  • Loading branch information
@hodoulp
hodoulp authored May 3, 2021
1 parent 7067004 commit 3318581
Show file tree
Hide file tree
Showing 3 changed files with 171 additions and 32 deletions.
32 changes: 23 additions & 9 deletions src/OpenColorIO/Config.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1300,21 +1300,35 @@ void Config::validate() const

// Only the 'predefined' mode imposes to have all the context variables explicitely defined
// in the config file. The 'all' mode exclusively relies on the environment variables.
if (getImpl()->m_context->getEnvironmentMode() == ENV_ENVIRONMENT_LOAD_PREDEFINED)
if (getMajorVersion() >= 2
&& getImpl()->m_context->getEnvironmentMode() == ENV_ENVIRONMENT_LOAD_PREDEFINED)
{
for (const auto & env : getImpl()->m_env)
{
const std::string ctxVariable = std::string("$") + env.first;
const std::string ctxValue
= getImpl()->m_context->resolveStringVar(ctxVariable.c_str());
const std::string ctxValue = env.second;

if (ContainsContextVariables(ctxValue))
{
std::ostringstream oss;
oss << "Unresolved context variable '"
<< env.first << " = "
<< env.second << "'.";
throw Exception(oss.str().c_str());
// When a context variable default value contains another context variable, the
// only legal case is ENV = $ENV. It means that there is no default value i.e. an
// system env. variable must exist.

const std::string ctxVariable1 = std::string("$") + env.first;
const std::string ctxVariable2 = std::string("${") + env.first + std::string("}");
const std::string ctxVariable3 = std::string("%") + env.first + std::string("%");

const bool isValid = (ctxVariable1 == ctxValue)
|| (ctxVariable2 == ctxValue)
|| (ctxVariable3 == ctxValue);

if (!isValid)
{
std::ostringstream oss;
oss << "Unresolved context variable in environment declaration '"
<< env.first << " = "
<< env.second << "'.";
throw Exception(oss.str().c_str());
}
}
}
}
Expand Down
7 changes: 5 additions & 2 deletions src/OpenColorIO/apphelpers/ColorSpaceHelpers.cpp
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// SPDX-License-Identifier: BSD-3-Clause
// Copyright Contributors to the OpenColorIO Project.


#include <cstring>
#include <map>
#include <mutex>
Expand All @@ -10,9 +11,11 @@
#include <OpenColorIO/OpenColorIO.h>

#include "ColorSpaceHelpers.h"
#include "Logging.h"
#include "Platform.h"
#include "utils/StringUtils.h"


namespace OCIO_NAMESPACE
{

Expand Down Expand Up @@ -374,8 +377,8 @@ ColorSpaceMenuHelperRcPtr ColorSpaceMenuHelper::Create(ConstColorSpaceMenuParame
catch (Exception & e)
{
std::ostringstream oss;
oss << "ColorSpaceMenuHelper needs a valid config. Validation failed with: " << e.what();
throw Exception(oss.str().c_str());
oss << "ColorSpaceMenuHelper needs a valid config. Validation warning is: " << e.what();
LogWarning(oss.str().c_str());
}

if (!p->getIncludeColorSpaces() && p->getIncludeRoles())
Expand Down
164 changes: 143 additions & 21 deletions tests/cpu/Config_tests.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -840,9 +840,6 @@ OCIO_ADD_TEST(Config, context_variable)
" VAR1: $VAR1\n" // No default value so the env. variable must exist.
" VAR2: var2\n" // Default value if env. variable does not exist.
" VAR3: env3\n" // Same as above.
" VAR4: env4$VAR1\n" // Same as above and built from another envvar.
" VAR5: env5$VAR2\n" // Same as above and built from another envvar.
" VAR6: env6$VAR3\n" // Same as above and built from another envvar.
"search_path: luts\n"
"strictparsing: true\n"
"luma: [0.2126, 0.7152, 0.0722]\n"
Expand Down Expand Up @@ -895,10 +892,6 @@ OCIO_ADD_TEST(Config, context_variable)
OCIO_CHECK_EQUAL(std::string("env2"), config->getCurrentContext()->resolveStringVar("$VAR2"));
OCIO_CHECK_EQUAL(std::string("env3"), config->getCurrentContext()->resolveStringVar("$VAR3"));

OCIO_CHECK_EQUAL(std::string("env4env1"), config->getCurrentContext()->resolveStringVar("$VAR4"));
OCIO_CHECK_EQUAL(std::string("env5env2"), config->getCurrentContext()->resolveStringVar("$VAR5"));
OCIO_CHECK_EQUAL(std::string("env6env3"), config->getCurrentContext()->resolveStringVar("$VAR6"));

std::ostringstream oss;
OCIO_CHECK_NO_THROW(oss << *config.get());
OCIO_CHECK_EQUAL(oss.str(), iss.str());
Expand All @@ -910,14 +903,146 @@ OCIO_ADD_TEST(Config, context_variable)
OCIO_CHECK_NO_THROW(config = OCIO::Config::CreateFromStream(iss));
OCIO_CHECK_NO_THROW(config->validate());

// Test a faulty case i.e. the env. variable VAR1 is now missing.
OCIO_CHECK_EQUAL(std::string("env1"), config->getCurrentContext()->resolveStringVar("$VAR1"));
OCIO_CHECK_EQUAL(std::string("var2"), config->getCurrentContext()->resolveStringVar("$VAR2"));
OCIO_CHECK_EQUAL(std::string("env3"), config->getCurrentContext()->resolveStringVar("$VAR3"));

// System env. variable VAR1 is now missing but the context variable VAR1 is still a valid one.

OCIO::Platform::Unsetenv("VAR1");
iss.str(CONFIG);
OCIO_CHECK_NO_THROW(config = OCIO::Config::CreateFromStream(iss));
OCIO_CHECK_THROW_WHAT(config->validate(),
OCIO::Exception,
"Unresolved context variable 'VAR1 = $VAR1'.");
OCIO_CHECK_NO_THROW(config->validate());

OCIO_CHECK_EQUAL(std::string("$VAR1"), config->getCurrentContext()->resolveStringVar("$VAR1"));
OCIO_CHECK_EQUAL(std::string("var2"), config->getCurrentContext()->resolveStringVar("$VAR2"));
OCIO_CHECK_EQUAL(std::string("env3"), config->getCurrentContext()->resolveStringVar("$VAR3"));
}

OCIO_ADD_TEST(Config, context_variable_unresolved)
{
// Test for invalid unresolved context variables.

static const std::string BODY_CONFIG =
"\n"
"search_path: luts\n"
"\n"
"roles:\n"
" default: cs1\n"
" reference: cs1\n"
"\n"
"displays:\n"
" disp1:\n"
" - !<View> {name: view1, colorspace: cs2}\n"
"\n"
"colorspaces:\n"
" - !<ColorSpace>\n"
" name: cs1\n"
"\n"
" - !<ColorSpace>\n"
" name: cs2\n"
" from_reference: !<MatrixTransform> {offset: [0.1, 0.2, 0.3, 0.0]}\n";

{
static const std::string CONFIG =
std::string("ocio_profile_version: 2\nenvironment: {ENV1: $ENV1}\n")
+ BODY_CONFIG;

std::istringstream iss;
iss.str(CONFIG);

OCIO::ConstConfigRcPtr config;
OCIO_CHECK_NO_THROW(config = OCIO::Config::CreateFromStream(iss));
OCIO_CHECK_NO_THROW(config->validate());
}

{
static const std::string CONFIG =
std::string("ocio_profile_version: 2\nenvironment:\n ENV1: ${ENV1}\n")
+ BODY_CONFIG;

std::istringstream iss;
iss.str(CONFIG);

OCIO::ConstConfigRcPtr config;
OCIO_CHECK_NO_THROW(config = OCIO::Config::CreateFromStream(iss));
OCIO_CHECK_NO_THROW(config->validate());
}

{
static const std::string CONFIG =
std::string("ocio_profile_version: 2\nenvironment: {ENV1: $ENV2}\n")
+ BODY_CONFIG;

std::istringstream iss;
iss.str(CONFIG);

OCIO::ConstConfigRcPtr config;
OCIO_CHECK_NO_THROW(config = OCIO::Config::CreateFromStream(iss));
OCIO_CHECK_THROW_WHAT(config->validate(),
OCIO::Exception,
"Unresolved context variable in environment declaration 'ENV1 = $ENV2'.");
}

{
static const std::string CONFIG =
std::string("ocio_profile_version: 2\nenvironment: {ENV1: env, ENV2: $ENV1}\n")
+ BODY_CONFIG;

std::istringstream iss;
iss.str(CONFIG);

OCIO::ConstConfigRcPtr config;
OCIO_CHECK_NO_THROW(config = OCIO::Config::CreateFromStream(iss));
OCIO_CHECK_THROW_WHAT(config->validate(),
OCIO::Exception,
"Unresolved context variable in environment declaration 'ENV2 = $ENV1'.");
}

{
static const std::string CONFIG =
std::string("ocio_profile_version: 2\nenvironment: {ENV1: env$ENV1}\n")
+ BODY_CONFIG;

std::istringstream iss;
iss.str(CONFIG);

OCIO::ConstConfigRcPtr config;
OCIO_CHECK_NO_THROW(config = OCIO::Config::CreateFromStream(iss));
OCIO_CHECK_THROW_WHAT(config->validate(),
OCIO::Exception,
"Unresolved context variable in environment declaration 'ENV1 = env$ENV1'.");
}

{
static const std::string CONFIG =
std::string("ocio_profile_version: 2\nenvironment:\n ENV1: env${ENV2}\n")
+ BODY_CONFIG;

std::istringstream iss;
iss.str(CONFIG);

OCIO::ConstConfigRcPtr config;
OCIO_CHECK_NO_THROW(config = OCIO::Config::CreateFromStream(iss));
OCIO_CHECK_THROW_WHAT(config->validate(),
OCIO::Exception,
"Unresolved context variable in environment declaration 'ENV1 = env${ENV2}'.");
}

{
static const std::string CONFIG =
std::string("ocio_profile_version: 2\nenvironment: {ENV1: $ENV1$ENV2}\n")
+ BODY_CONFIG;

std::istringstream iss;
iss.str(CONFIG);

OCIO::ConstConfigRcPtr config;
OCIO_CHECK_NO_THROW(config = OCIO::Config::CreateFromStream(iss));
OCIO_CHECK_THROW_WHAT(config->validate(),
OCIO::Exception,
"Unresolved context variable in environment declaration 'ENV1 = $ENV1$ENV2'.");
}
}

OCIO_ADD_TEST(Config, context_variable_with_sanity_check)
Expand Down Expand Up @@ -994,26 +1119,23 @@ OCIO_ADD_TEST(Config, context_variable_with_sanity_check)
}

{
// Update $CS2 to use $TOTO. That's still a self-contained context because
// $TOTO exists.
// Update $CS2 to use $TOTO. That's an invalid case because a context variable value can
// only be a string (i.e. "VAR: env") or the context variable itself (i.e. "VAR: $VAR").
OCIO_CHECK_NO_THROW(cfg->addEnvironmentVar("CS2", "$TOTO"));
OCIO_CHECK_EQUAL(cfg->getNumEnvironmentVars(), 2);
OCIO_CHECK_NO_THROW(cfg->validate());

// Note that the default value of the context variable is unresolved.
OCIO_CHECK_EQUAL(std::string(cfg->getEnvironmentVarDefault("CS2")), std::string("$TOTO"));
OCIO_CHECK_THROW_WHAT(cfg->validate(),
OCIO::Exception,
"Unresolved context variable in environment declaration 'CS2 = $TOTO'.");
}

{
// Remove $TOTO from the context. That's a faulty case because $CS2 is still used
// but resolved using $TOTO so, the environment is not self-contained. Sanity check
// must throw in that case.
// Remove $TOTO from the context. That's an invalid case as explained above.
OCIO_CHECK_NO_THROW(cfg->addEnvironmentVar("TOTO", nullptr));
OCIO_CHECK_EQUAL(cfg->getNumEnvironmentVars(), 1);

OCIO_CHECK_THROW_WHAT(cfg->validate(),
OCIO::Exception,
"Unresolved context variable 'CS2 = $TOTO'.");
"Unresolved context variable in environment declaration 'CS2 = $TOTO'.");
OCIO_CHECK_THROW_WHAT(cfg->getProcessor("cs1", "disp1", "view1", OCIO::TRANSFORM_DIR_FORWARD),
OCIO::Exception,
"The specified file reference '$CS2' could not be located");
Expand Down

0 comments on commit 3318581

Please sign in to comment.