try to work around the LogicalNot(ResponseHeaderSame) behaviour

symfony · jschaedl · Feb 3, 2023 · Nov 26, 2023 · Nov 29, 2023 · 81ecde59aa2eb634bd781bf2248e385fa7a2f5f7
commit 81ecde59aa2eb634bd781bf2248e385fa7a2f5f7
diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/BrowserKitAssertionsTrait.php b/src/Symfony/Bundle/FrameworkBundle/Test/BrowserKitAssertionsTrait.php
@@ -79,7 +79,7 @@ public static function assertResponseHeaderSame(string $headerName, string $expe

    public static function assertResponseHeaderNotSame(string $headerName, string $expectedValue, string $message = ''): void
    {
-        self::assertThatForResponse(new LogicalNot(new ResponseConstraint\ResponseHeaderSame($headerName, $expectedValue)), $message);
+        self::assertThatForResponse(new LogicalNot(new ResponseConstraint\ResponseHeaderSame($headerName, $expectedValue, true)), $message);
    }

    public static function assertResponseHasCookie(string $name, string $path = '/', string $domain = null, string $message = ''): void

diff --git a/src/Symfony/Component/HttpFoundation/Test/Constraint/ResponseHeaderSame.php b/src/Symfony/Component/HttpFoundation/Test/Constraint/ResponseHeaderSame.php
@@ -18,12 +18,14 @@ final class ResponseHeaderSame extends Constraint
 {
    private string $headerName;
    private string $expectedValue;
+    private bool $logicalNot;
    private ?string $actualValue = null;

-    public function __construct(string $headerName, string $expectedValue)
+    public function __construct(string $headerName, string $expectedValue, bool $logicalNot = false)
    {
        $this->headerName = $headerName;
        $this->expectedValue = $expectedValue;
+        $this->logicalNot = $logicalNot;
    }

    public function toString(): string
@@ -34,7 +36,7 @@ public function toString(): string
            $output .= sprintf(', header "%s" is not set', $this->headerName);
        }

-        if (null !== $this->actualValue) {
+        if (null !== $this->actualValue && !$this->logicalNot) {
            $output .= sprintf(', value of header "%s" is "%s"', $this->headerName, $this->actualValue);
        }
-Original file line number
+Diff line change
@@ -18,12 +18,14 @@ final class ResponseHeaderSame extends Constraint
     {
         private string $headerName;
         private string $expectedValue;
+        private bool $logicalNot;
         private ?string $actualValue = null;
-        public function __construct(string $headerName, string $expectedValue)
+        public function __construct(string $headerName, string $expectedValue, bool $logicalNot = false)
             Copy link

  
      
    
  

  
      

  
    Contributor


      

  Author


  

  
    
      

      
            jschaedl
  

      

      

      


        Nov 26, 2023


      
  •

  
    
      
        
          edited
          
        
        
      
    
    
      
  
        
      Loading


  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  
    
  


    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      Why is this needed?
Let me try to explain:
The test case for the assertResponseHeaderNotSame
public function testAssertResponseHeaderNotSame()
{
    $this->getResponseTester(new Response())->assertResponseHeaderNotSame('Cache-Control', 'public');
    $this->expectException(AssertionFailedError::class);
    $this->expectExceptionMessage('Failed asserting that the Response does not have header "Cache-Control" with value "no-cache, private", value of header "Cache-Control" is "no-cache, private".');
    $this->getResponseTester(new Response())->assertResponseHeaderNotSame('Cache-Control', 'no-cache, private');
}
failed with:

Failed asserting that exception message
'Failed asserting that the Response does not have header "Cache-Control" with value "no-cache, private", value of header "Cache-Control" is not "no-cache, private".'
contains
'Failed asserting that the Response does not have header "Cache-Control" with value "no-cache, private", value of header "Cache-Control" is "no-cache, private".'.


Please notice the not in the actual exception message.

This is happening because the assertResponseHeaderNotSame assertion uses a ResponseHeaderSame constraint internally. This constraint is wrapped by a LogicalNot which is in fact the reason all messages for this constraint are negated.
So the best idea I had so far is to "ignore" the logical not case.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
         {
             $this->headerName = $headerName;
             $this->expectedValue = $expectedValue;
+            $this->logicalNot = $logicalNot;
         }
         public function toString(): string
@@ -34,7 +36,7 @@ public function toString(): string
                 $output .= sprintf(', header "%s" is not set', $this->headerName);
             }
-            if (null !== $this->actualValue) {
+            if (null !== $this->actualValue && !$this->logicalNot) {
                 $output .= sprintf(', value of header "%s" is "%s"', $this->headerName, $this->actualValue);
             }
-          Expand Down