[FrameworkBundle] Allow setting private services with the test container #17734

alexandre-daubois · Jan 13, 2023

alamirault

I think part of this section is outdated with this new feature.

We can keep the following doc with some adjustments (ex: remove "// the following line won't work unless the alias is made public ")

symfony-docs/testing.rst

Lines 289 to 323 in d1c0d4a

    
           Sometimes it can be useful to mock a dependency of a tested service. 
        
           From the example in the previous section, let's assume the 
        
           ``NewsletterGenerator`` has a dependency to a private alias 
        
           ``NewsRepositoryInterface`` pointing to a private ``NewsRepository`` service 
        
           and you'd like to use a mocked ``NewsRepositoryInterface`` instead of the 
        
           concrete one:: 
        
               // ... 
        
               use App\Contracts\Repository\NewsRepositoryInterface; 
        
               class NewsletterGeneratorTest extends KernelTestCase 
        
               { 
        
                   public function testSomething() 
        
                   { 
        
                       // ... same bootstrap as the section above 
        
                       $newsRepository = $this->createMock(NewsRepositoryInterface::class); 
        
                       $newsRepository->expects(self::once()) 
        
                           ->method('findNewsFromLastMonth') 
        
                           ->willReturn([ 
        
                               new News('some news'), 
        
                               new News('some other news'), 
        
                           ]) 
        
                       ; 
        
                       // the following line won't work unless the alias is made public 
        
                       $container->set(NewsRepositoryInterface::class, $newsRepository); 
        
                       // will be injected the mocked repository 
        
                       $newsletterGenerator = $container->get(NewsletterGenerator::class); 
        
                       // ... 
        
                   } 
        
               }

We can add a versionadded to tell is new.
And for "old" way I think we should remove it in 7.0. However I don't know in which block it must be documented (deprecated ?)

alexandre-daubois · Jan 14, 2023

@alamirault Good point! I updated the PR. Does it feel more natural?

OskarStark · Jan 14, 2023

testing.rst

@@ -321,52 +320,11 @@ concrete one::
        }
    }

-In order to make the alias public, you will need to update configuration for
-the ``test`` environment as follows:
+.. deprecated:: 6.3


This get removed in 7.0

I think we should add a versionadded that this is now possible from 6.3 on

Is the first version (1f09911) what you mean, but with versionadded instead of tip?

Always keep in mind to keep the info itself "forever" and only the versionadded directive unit the next major

Alright, it gets more and more clear. I tried a new version that will "keep the info forever" but also with a versionadded. Hope it is the way to go!

javiereguiluz · Jan 17, 2023

Great feature (thanks Nicolas); great contribution (thanks Alex); and great review (thanks Antoine and Oskar).

nicolas-grekas

        // the following line won't work unless the alias is made public

not true anymore ;)

javiereguiluz · Jan 18, 2023

True! I removed it while merging 🙌

carsonbot added Status: Needs Review FrameworkBundle labels Jan 13, 2023

carsonbot added this to the 6.3 milestone Jan 13, 2023

alamirault reviewed Jan 13, 2023

View reviewed changes

alexandre-daubois force-pushed the feat-set-private-service branch from 1f09911 to 010c3b1 Compare January 14, 2023 15:06

alexandre-daubois force-pushed the feat-set-private-service branch 2 times, most recently from dded8a9 to c6c9186 Compare January 14, 2023 15:09

alamirault approved these changes Jan 14, 2023

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Jan 14, 2023

OskarStark reviewed Jan 14, 2023

View reviewed changes

[FrameworkBundle] Allow setting private services with the test container

f305d37

alexandre-daubois force-pushed the feat-set-private-service branch from c6c9186 to f305d37 Compare January 15, 2023 11:36

OskarStark approved these changes Jan 15, 2023

View reviewed changes

OskarStark requested a review from javiereguiluz January 15, 2023 18:51

carsonbot added Status: Needs Review and removed Status: Reviewed labels Jan 15, 2023

javiereguiluz merged commit 97ea1f2 into symfony:6.3 Jan 17, 2023

alexandre-daubois deleted the feat-set-private-service branch January 17, 2023 15:11

alexislefebvre mentioned this pull request Jan 17, 2023

[FrameworkBundle] Allow setting private services with the test container #17733

Closed

nicolas-grekas reviewed Jan 18, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[FrameworkBundle] Allow setting private services with the test container #17734

[FrameworkBundle] Allow setting private services with the test container #17734

Uh oh!

alexandre-daubois commented Jan 13, 2023

Uh oh!

alamirault left a comment •

edited

Loading

Uh oh!

alexandre-daubois commented Jan 14, 2023

Uh oh!

OskarStark Jan 14, 2023

Uh oh!

alexandre-daubois Jan 14, 2023 •

edited

Loading

Uh oh!

OskarStark Jan 15, 2023

Uh oh!

alexandre-daubois Jan 15, 2023

Uh oh!

javiereguiluz commented Jan 17, 2023

Uh oh!

nicolas-grekas left a comment

Uh oh!

javiereguiluz commented Jan 18, 2023

Uh oh!

Uh oh!

	Sometimes it can be useful to mock a dependency of a tested service.
	From the example in the previous section, let's assume the
	``NewsletterGenerator`` has a dependency to a private alias
	``NewsRepositoryInterface`` pointing to a private ``NewsRepository`` service
	and you'd like to use a mocked ``NewsRepositoryInterface`` instead of the
	concrete one::

	// ...
	use App\Contracts\Repository\NewsRepositoryInterface;

	class NewsletterGeneratorTest extends KernelTestCase
	{
	public function testSomething()
	{
	// ... same bootstrap as the section above

	$newsRepository = $this->createMock(NewsRepositoryInterface::class);
	$newsRepository->expects(self::once())
	->method('findNewsFromLastMonth')
	->willReturn([
	new News('some news'),
	new News('some other news'),
	])
	;

	// the following line won't work unless the alias is made public
	$container->set(NewsRepositoryInterface::class, $newsRepository);

	// will be injected the mocked repository
	$newsletterGenerator = $container->get(NewsletterGenerator::class);

	// ...
	}
	}

Search code, repositories, users, issues, pull requests...

Uh oh!

[FrameworkBundle] Allow setting private services with the test container #17734

[FrameworkBundle] Allow setting private services with the test container #17734

Uh oh!

Conversation

alexandre-daubois commented Jan 13, 2023

Uh oh!

alamirault left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexandre-daubois commented Jan 14, 2023

Uh oh!

OskarStark Jan 14, 2023

Choose a reason for hiding this comment

Uh oh!

alexandre-daubois Jan 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OskarStark Jan 15, 2023

Choose a reason for hiding this comment

Uh oh!

alexandre-daubois Jan 15, 2023

Choose a reason for hiding this comment

Uh oh!

javiereguiluz commented Jan 17, 2023

Uh oh!

nicolas-grekas left a comment

Choose a reason for hiding this comment

Uh oh!

javiereguiluz commented Jan 18, 2023

Uh oh!

Uh oh!

alamirault left a comment •

edited

Loading

alexandre-daubois Jan 14, 2023 •

edited

Loading