Executor: Do not assert on condition that can actually happen.v1.5.1

We asserted on the condition that a node's product must be in the list
of products to build, meaning that it needs to belong to the set of
user-selected products or one of their dependencies. However, there are
at least two ways in which one can trigger this condition to be false:
1) The user provides a faulty project in which a "Depends" item is
missing, but the respective artifact from the other product is still
found (e.g. a generated header file via a project-global include
path).
2) The project is actually okay, but our C++ scanner erroneously adds
dependencies from a different product, e.g. because it does not know
about #ifdefs.

Instead of the assertion, we now simply mark the respective node as
built and continue. Ideally, we'd log a warning, but we cannot do that
because of point 2) above.

Change-Id: I3549d732dea5cde84d1019132580a8e051c9db11
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>

1 files changed, 20 insertions, 3 deletions

diff --git a/src/lib/corelib/buildgraph/executor.cpp b/src/lib/corelib/buildgraph/executor.cpp
index be5a93302..2706d0323 100644
--- a/src/lib/corelib/buildgraph/executor.cpp
+++ b/src/lib/corelib/buildgraph/executor.cpp
@@ -408,6 +408,9 @@ void Executor::buildArtifact(Artifact *artifact)
 
     QBS_CHECK(artifact->buildState == BuildGraphNode::Buildable);
 
+    if (artifact->artifactType != Artifact::SourceFile && !checkNodeProduct(artifact))
+        return;
+
     // skip artifacts without transformer
     if (artifact->artifactType != Artifact::Generated) {
         // For source artifacts, that were not reachable when initializing the build, we must
@@ -430,6 +433,9 @@ void Executor::buildArtifact(Artifact *artifact)
 
 void Executor::executeRuleNode(RuleNode *ruleNode)
 {
+    if (!checkNodeProduct(ruleNode))
+        return;
+
     QBS_CHECK(!m_evalContext->isActive());
     ArtifactSet changedInputArtifacts;
     if (ruleNode->rule()->isDynamic()) {
@@ -972,6 +978,20 @@ void Executor::checkForUnbuiltProducts()
     }
 }
 
+bool Executor::checkNodeProduct(BuildGraphNode *node)
+{
+    if (m_productsToBuild.contains(node->product))
+        return true;
+
+    // TODO: Turn this into a warning once we have a reliable C++ scanner.
+    m_logger.qbsTrace() << "Ignoring node " << node->toString() << ", which belongs to a "
+                            "product that is not part of the list of products to build. "
+                            "Possible reasons are an erroneous project design or a false "
+                            "positive from a dependency scanner.";
+    finishNode(node);
+    return false;
+}
+
 void Executor::finish()
 {
     QBS_ASSERT(m_state != ExecutorIdle, /* ignore */);
@@ -1007,8 +1027,6 @@ void Executor::checkForCancellation()
 bool Executor::visit(Artifact *artifact)
 {
     QBS_CHECK(artifact->buildState != BuildGraphNode::Untouched);
-    QBS_CHECK(artifact->artifactType == Artifact::SourceFile
-              || m_productsToBuild.contains(artifact->product));
     buildArtifact(artifact);
     return false;
 }
@@ -1016,7 +1034,6 @@ bool Executor::visit(Artifact *artifact)
 bool Executor::visit(RuleNode *ruleNode)
 {
     QBS_CHECK(ruleNode->buildState != BuildGraphNode::Untouched);
-    QBS_CHECK(m_productsToBuild.contains(ruleNode->product));
     executeRuleNode(ruleNode);
     return false;
 }