Move Mock class at the send of the test class

symfony · pasdeloup · Jun 29, 2016 · Jun 29, 2016 · Jun 29, 2016 · Jun 29, 2016
commit 30d1d7d66b1347dcbba4d989e183a772df7b4ec4
diff --git a/src/Symfony/Component/Security/Guard/Tests/Authenticator/FormLoginAuthenticatorTest.php b/src/Symfony/Component/Security/Guard/Tests/Authenticator/FormLoginAuthenticatorTest.php
@@ -13,6 +13,9 @@

 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
+use Symfony\Component\Security\Core\User\UserInterface;
+use Symfony\Component\Security\Core\User\UserProviderInterface;
+use Symfony\Component\Security\Guard\Authenticator\AbstractFormLoginAuthenticator;

 /**
 * @author Jean Pasdeloup <jpasdeloup@sedona.fr>
@@ -110,3 +113,73 @@ protected function tearDown()
        $this->requestWithSession = null;
    }
 }
+
+class MockFormLoginAuthenticator extends AbstractFormLoginAuthenticator
+{
+    private $loginUrl;
+    private $defaultSuccessRedirectUrl;
+
+    /**
+     * @param mixed $defaultSuccessRedirectUrl
+     *
+     * @return MockFormLoginAuthenticator
+     */
+    public function setDefaultSuccessRedirectUrl($defaultSuccessRedirectUrl)
+    {
+        $this->defaultSuccessRedirectUrl = $defaultSuccessRedirectUrl;
+
+        return $this;
+    }
+
+    /**
+     * @param mixed $loginUrl
+     *
+     * @return MockFormLoginAuthenticator
+     */
+    public function setLoginUrl($loginUrl)
+    {
+        $this->loginUrl = $loginUrl;
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getLoginUrl()
+    {
+        return $this->loginUrl;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getDefaultSuccessRedirectUrl()
+    {
+        return $this->defaultSuccessRedirectUrl;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getCredentials(Request $request)
+    {
+        return 'credentials';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getUser($credentials, UserProviderInterface $userProvider)
+    {
+        return $userProvider->loadUserByUsername($credentials);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function checkCredentials($credentials, UserInterface $user)
+    {
+        return true;
+    }
+}
diff --git a/src/Symfony/Component/Security/Guard/Tests/Authenticator/MockFormLoginAuthenticator.php b/src/Symfony/Component/Security/Guard/Tests/Authenticator/MockFormLoginAuthenticator.php
-Original file line number
+Diff line change
@@ -13,6 +13,9 @@
     use Symfony\Component\HttpFoundation\Request;
     use Symfony\Component\Security\Core\Exception\AuthenticationException;
+    use Symfony\Component\Security\Core\User\UserInterface;
+    use Symfony\Component\Security\Core\User\UserProviderInterface;
+    use Symfony\Component\Security\Guard\Authenticator\AbstractFormLoginAuthenticator;
     /**
      * @author Jean Pasdeloup <jpasdeloup@sedona.fr>
@@ -110,3 +113,73 @@ protected function tearDown()
             $this->requestWithSession = null;
         }
     }
+    class MockFormLoginAuthenticator extends AbstractFormLoginAuthenticator
             Copy link

  
      
    
  

  
      

  
  Member


      

  

  
    
      

      
            nicolas-grekas
  

      

      

      


        Jun 30, 2016


      
  •

  
    
      
        
          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.
    

    
      
      


  


  
    
      I think we usually name these TestFormLoginAuthenticator, because that's what you test, isn't it? (not a dep you mock)
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

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


  
  


          
      
  
    
    
            xabbuh reacted with thumbs up emoji
      
        
            
    All reactions
  


          
              
                👍
                  1 reaction
              
          
        
      
    

    



  
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
  Member


      

  

  
    
      

      
            xabbuh
  

      

      

      


        Jun 30, 2016


      
    

  


        
      
  
  
  
    

    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.
    

    
      
      


  


  
    
      Actually, just using FormLoginAuthenticator as class name would fit here too.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

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


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



  
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
    Contributor


      

  Author


  

  
    
      

      
            pasdeloup
  

      

      

      


        Jun 30, 2016


      
    

  


        
      
  
  
  
    

    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.
    

    
      
      


  


  
    
      You're right, it's not a Mock as it's what is tested, and that's why I didn't like the idea of using a PHPUnit mock either.
I checked in the code to be consistent with existing code for abstract class testings and found 2 main ways of doing it (and a few mixes) :

Test class should be named FormLoginAuthenticatorTest

Tested concrete class is defined after the test and named TestFormLoginAuthenticator
Test class should be named AbstractFormLoginAuthenticatorTest

Tested concrete class is defined before the test and named ConcreteFormLoginAuthenticator

I pushed a version using the 1st way as it seems the more common.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

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


  
  


          
      
  
    
    
      
        
            
    All reactions
+    {
+        private $loginUrl;
+        private $defaultSuccessRedirectUrl;
+        /**
+         * @param mixed $defaultSuccessRedirectUrl
+         *
+         * @return MockFormLoginAuthenticator
+         */
+        public function setDefaultSuccessRedirectUrl($defaultSuccessRedirectUrl)
+        {
+            $this->defaultSuccessRedirectUrl = $defaultSuccessRedirectUrl;
+            return $this;
+        }
+        /**
+         * @param mixed $loginUrl
+         *
+         * @return MockFormLoginAuthenticator
+         */
+        public function setLoginUrl($loginUrl)
+        {
+            $this->loginUrl = $loginUrl;
+            return $this;
+        }
+        /**
+         * {@inheritdoc}
+         */
+        protected function getLoginUrl()
+        {
+            return $this->loginUrl;
+        }
+        /**
+         * {@inheritdoc}
+         */
+        protected function getDefaultSuccessRedirectUrl()
+        {
+            return $this->defaultSuccessRedirectUrl;
+        }
+        /**
+         * {@inheritdoc}
+         */
+        public function getCredentials(Request $request)
+        {
+            return 'credentials';
+        }
+        /**
+         * {@inheritdoc}
+         */
+        public function getUser($credentials, UserProviderInterface $userProvider)
+        {
+            return $userProvider->loadUserByUsername($credentials);
+        }
+        /**
+         * {@inheritdoc}
+         */
+        public function checkCredentials($credentials, UserInterface $user)
+        {
+            return true;
+        }
+    }