InversionOfControl/Castle.MicroKernel.Tests/SubContainers/SubContainersTestCase.cs

   1 // Copyright 2004-2007 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.MicroKernel.Tests.SubContainers
  16 {
  17         using System;
  18         using System.Collections;
  19         using Castle.Core;
  20         using Castle.MicroKernel.Tests.ClassComponents;
  21         using NUnit.Framework;
  22
  23         /// <summary>
  24         /// Summary description for SubContainersTestCase.
  25         /// </summary>
  26         [TestFixture]
  27         public class SubContainersTestCase
  28         {
  29                 private IKernel kernel;
  30
  31                 [SetUp]
  32                 public void Init()
  33                 {
  34                         kernel = new DefaultKernel();
  35                 }
  36
  37                 [TearDown]
  38                 public void Dispose()
  39                 {
  40                         kernel.Dispose();
  41                 }
  42
  43                 [Test]
  44                 public void ChildDependenciesSatisfiedAmongContainers()
  45                 {
  46                         IKernel subkernel = new DefaultKernel();
  47
  48                         kernel.AddComponent("templateengine", typeof(DefaultTemplateEngine));
  49                         kernel.AddComponent("mailsender", typeof(DefaultMailSenderService));
  50
  51                         kernel.AddChildKernel(subkernel);
  52                         subkernel.AddComponent("spamservice", typeof(DefaultSpamService));
  53
  54                         DefaultSpamService spamservice = (DefaultSpamService) subkernel["spamservice"];
  55
  56                         Assert.IsNotNull(spamservice);
  57                         Assert.IsNotNull(spamservice.MailSender);
  58                         Assert.IsNotNull(spamservice.TemplateEngine);
  59                 }
  60
  61                 [Test]
  62                 public void ChildDependenciesIsSatisfiedEvenWhenComponentTakesLongToBeAddedToParentContainer()
  63                 {
  64                         DefaultKernel container = new DefaultKernel();
  65                         DefaultKernel childContainer = new DefaultKernel();
  66
  67                         container.AddChildKernel(childContainer);
  68                         childContainer.AddComponent("component", typeof(Component));
  69
  70                         container.AddComponent("service1", typeof(IService), typeof(Service));
  71
  72                         Component comp = (Component) childContainer[typeof(Component)];
  73                 }
  74
  75                 [Test, Ignore("This need to be discussed")]
  76                 public void SameLevelDependenciesSatisfied()
  77                 {
  78                         IKernel child = new DefaultKernel();
  79
  80                         kernel.AddComponent("templateengine", typeof(DefaultTemplateEngine));
  81                         kernel.AddComponent("spamservice", typeof(DefaultSpamService));
  82
  83                         kernel.AddChildKernel(child);
  84
  85                         child.AddComponent("mailsender", typeof(DefaultMailSenderService));
  86
  87                         DefaultSpamService spamservice = (DefaultSpamService) child["spamservice"];
  88
  89                         Assert.IsNotNull(spamservice);
  90                         Assert.IsNotNull(spamservice.MailSender);
  91                         Assert.IsNotNull(spamservice.TemplateEngine);
  92                 }
  93
  94                 [Test, Ignore("This is not passing, and anyway, the goal should be reviewed")]
  95                 public void UseChildComponentsForParentDependenciesWhenRequestedFromChild()
  96                 {
  97                         IKernel subkernel = new DefaultKernel();
  98
  99                         kernel.AddComponent("spamservice", typeof(DefaultSpamService), LifestyleType.Transient);
 100                         kernel.AddComponent("mailsender", typeof(DefaultMailSenderService));
 101                         kernel.AddComponent("templateengine", typeof(DefaultTemplateEngine));
 102
 103                         kernel.AddChildKernel(subkernel);
 104                         subkernel.AddComponent("templateengine", typeof(DefaultTemplateEngine));
 105
 106                         DefaultTemplateEngine templateengine = (DefaultTemplateEngine) kernel["templateengine"];
 107                         DefaultTemplateEngine sub_templateengine = (DefaultTemplateEngine) subkernel["templateengine"];
 108
 109                         DefaultSpamService spamservice = (DefaultSpamService) subkernel["spamservice"];
 110                         Assert.AreNotEqual(spamservice.TemplateEngine, templateengine);
 111                         Assert.AreEqual(spamservice.TemplateEngine, sub_templateengine);
 112
 113                         spamservice = (DefaultSpamService) kernel["spamservice"];
 114                         Assert.AreNotEqual(spamservice.TemplateEngine, sub_templateengine);
 115                         Assert.AreEqual(spamservice.TemplateEngine, templateengine);
 116
 117                         kernel.RemoveComponent("templateengine");
 118                         spamservice = (DefaultSpamService) kernel["spamservice"];
 119                         Assert.IsNull(spamservice.TemplateEngine);
 120                 }
 121
 122                 [Test, Ignore("This is not passing, and anyway, the goal should be reviewed")]
 123                 public void Singleton_WithNonSingletonDependencies_DoesNotReResolveDependencies()
 124                 {
 125                         kernel.AddComponent("spamservice", typeof(DefaultSpamService));
 126                         kernel.AddComponent("mailsender", typeof(DefaultMailSenderService));
 127
 128                         IKernel subkernel1 = new DefaultKernel();
 129                         subkernel1.AddComponent("templateengine", typeof(DefaultTemplateEngine));
 130                         kernel.AddChildKernel(subkernel1);
 131
 132                         IKernel subkernel2 = new DefaultKernel();
 133                         subkernel2.AddComponent("templateengine", typeof(DefaultTemplateEngine), LifestyleType.Transient);
 134                         kernel.AddChildKernel(subkernel2);
 135
 136                         DefaultTemplateEngine templateengine1 = (DefaultTemplateEngine) subkernel1["templateengine"];
 137                         DefaultSpamService spamservice1 = (DefaultSpamService) subkernel1["spamservice"];
 138                         Assert.IsNotNull(spamservice1);
 139                         Assert.AreEqual(spamservice1.TemplateEngine.Key, templateengine1.Key);
 140
 141                         DefaultTemplateEngine templateengine2 = (DefaultTemplateEngine) subkernel2["templateengine"];
 142                         DefaultSpamService spamservice2 = (DefaultSpamService) subkernel2["spamservice"];
 143                         Assert.IsNotNull(spamservice2);
 144                         Assert.AreEqual(spamservice1, spamservice2);
 145                         Assert.AreEqual(spamservice1.TemplateEngine.Key, templateengine1.Key);
 146                         Assert.AreNotEqual(spamservice2.TemplateEngine.Key, templateengine2.Key);
 147                 }
 148
 149                 [Test]
 150                 public void DependenciesSatisfiedAmongContainers()
 151                 {
 152                         IKernel subkernel = new DefaultKernel();
 153
 154                         kernel.AddComponent("mailsender", typeof(DefaultMailSenderService));
 155                         kernel.AddComponent("templateengine", typeof(DefaultTemplateEngine));
 156
 157                         kernel.AddChildKernel(subkernel);
 158
 159                         subkernel.AddComponent("spamservice", typeof(DefaultSpamService));
 160
 161                         DefaultSpamService spamservice = (DefaultSpamService) subkernel["spamservice"];
 162
 163                         Assert.IsNotNull(spamservice);
 164                         Assert.IsNotNull(spamservice.MailSender);
 165                         Assert.IsNotNull(spamservice.TemplateEngine);
 166                 }
 167
 168                 [Test]
 169                 public void DependenciesSatisfiedAmongContainersUsingEvents()
 170                 {
 171                         IKernel subkernel = new DefaultKernel();
 172
 173                         subkernel.AddComponent("spamservice", typeof(DefaultSpamServiceWithConstructor));
 174
 175                         kernel.AddComponent("mailsender", typeof(DefaultMailSenderService));
 176                         kernel.AddComponent("templateengine", typeof(DefaultTemplateEngine));
 177
 178                         kernel.AddChildKernel(subkernel);
 179
 180                         DefaultSpamServiceWithConstructor spamservice =
 181                                 (DefaultSpamServiceWithConstructor) subkernel["spamservice"];
 182
 183                         Assert.IsNotNull(spamservice);
 184                         Assert.IsNotNull(spamservice.MailSender);
 185                         Assert.IsNotNull(spamservice.TemplateEngine);
 186                 }
 187
 188                 [Test]
 189                 public void ChildKernelFindsAndCreateParentComponent()
 190                 {
 191                         IKernel subkernel = new DefaultKernel();
 192
 193                         kernel.AddComponent("templateengine", typeof(DefaultTemplateEngine));
 194
 195                         kernel.AddChildKernel(subkernel);
 196
 197
 198                         Assert.IsTrue(subkernel.HasComponent(typeof(DefaultTemplateEngine)));
 199                         Assert.IsNotNull(subkernel[typeof(DefaultTemplateEngine)]);
 200                 }
 201
 202                 [Test]
 203                 [ExpectedException(typeof(ComponentNotFoundException))]
 204                 public void ParentKernelFindsAndCreateChildComponent()
 205                 {
 206                         IKernel subkernel = new DefaultKernel();
 207
 208                         subkernel.AddComponent("templateengine", typeof(DefaultTemplateEngine));
 209
 210                         kernel.AddChildKernel(subkernel);
 211
 212
 213                         Assert.IsFalse(kernel.HasComponent(typeof(DefaultTemplateEngine)));
 214                         object engine = kernel[typeof(DefaultTemplateEngine)];
 215                 }
 216
 217                 [Test]
 218                 public void ChildKernelOverloadsParentKernel1()
 219                 {
 220                         DefaultTemplateEngine instance1 = new DefaultTemplateEngine();
 221                         DefaultTemplateEngine instance2 = new DefaultTemplateEngine();
 222
 223                         // subkernel added with already registered components that overload parent components.
 224
 225                         IKernel subkernel = new DefaultKernel();
 226                         subkernel.AddComponentInstance("engine", instance1);
 227                         Assert.AreEqual(instance1, subkernel["engine"]);
 228
 229                         kernel.AddComponentInstance("engine", instance2);
 230                         Assert.AreEqual(instance2, kernel["engine"]);
 231
 232                         kernel.AddChildKernel(subkernel);
 233                         Assert.AreEqual(instance1, subkernel["engine"]);
 234                         Assert.AreEqual(instance2, kernel["engine"]);
 235                 }
 236
 237                 [Test]
 238                 public void ChildKernelOverloadsParentKernel2()
 239                 {
 240                         DefaultTemplateEngine instance1 = new DefaultTemplateEngine();
 241                         DefaultTemplateEngine instance2 = new DefaultTemplateEngine();
 242
 243                         IKernel subkernel = new DefaultKernel();
 244                         kernel.AddChildKernel(subkernel);
 245
 246                         // subkernel added first, then populated with overloaded components after
 247
 248                         kernel.AddComponentInstance("engine", instance2);
 249                         Assert.AreEqual(instance2, kernel["engine"]);
 250                         Assert.AreEqual(instance2, subkernel["engine"]);
 251
 252                         subkernel.AddComponentInstance("engine", instance1);
 253                         Assert.AreEqual(instance1, subkernel["engine"]);
 254                         Assert.AreEqual(instance2, kernel["engine"]);
 255                 }
 256
 257                 [Test]
 258                 public void RemoveChildKernelCleansUp()
 259                 {
 260                         IKernel subkernel = new DefaultKernel();
 261                         EventsCollector eventCollector = new EventsCollector(subkernel);
 262                         subkernel.RemovedAsChildKernel += new EventHandler(eventCollector.RemovedAsChildKernel);
 263                         subkernel.AddedAsChildKernel += new EventHandler(eventCollector.AddedAsChildKernel);
 264
 265                         kernel.AddChildKernel(subkernel);
 266                         Assert.AreEqual(kernel, subkernel.Parent);
 267                         Assert.AreEqual(1, eventCollector.Events.Count);
 268                         Assert.AreEqual(EventsCollector.Added, eventCollector.Events[0]);
 269
 270                         kernel.RemoveChildKernel(subkernel);
 271                         Assert.IsNull(subkernel.Parent);
 272                         Assert.AreEqual(2, eventCollector.Events.Count);
 273                         Assert.AreEqual(EventsCollector.Removed, eventCollector.Events[1]);
 274                 }
 275
 276                 [Test]
 277                 [ExpectedException(typeof(KernelException),
 278                         "You can not change the kernel parent once set, use the RemoveChildKernel and AddChildKernel methods together to achieve this."
 279                         )]
 280                 public void AddChildKernelToTwoParentsThrowsException()
 281                 {
 282                         IKernel kernel2 = new DefaultKernel();
 283
 284                         IKernel subkernel = new DefaultKernel();
 285
 286                         kernel.AddChildKernel(subkernel);
 287                         Assert.AreEqual(kernel, subkernel.Parent);
 288
 289                         kernel2.AddChildKernel(subkernel);
 290                 }
 291
 292                 [Test]
 293                 public void RemovingChildKernelUnsubscribesFromParentEvents()
 294                 {
 295                         IKernel subkernel = new DefaultKernel();
 296                         EventsCollector eventCollector = new EventsCollector(subkernel);
 297                         subkernel.RemovedAsChildKernel += new EventHandler(eventCollector.RemovedAsChildKernel);
 298                         subkernel.AddedAsChildKernel += new EventHandler(eventCollector.AddedAsChildKernel);
 299
 300                         kernel.AddChildKernel(subkernel);
 301                         kernel.RemoveChildKernel(subkernel);
 302                         kernel.AddChildKernel(subkernel);
 303                         kernel.RemoveChildKernel(subkernel);
 304
 305                         Assert.AreEqual(4, eventCollector.Events.Count);
 306                         Assert.AreEqual(EventsCollector.Added, eventCollector.Events[0]);
 307                         Assert.AreEqual(EventsCollector.Removed, eventCollector.Events[1]);
 308                         Assert.AreEqual(EventsCollector.Added, eventCollector.Events[2]);
 309                         Assert.AreEqual(EventsCollector.Removed, eventCollector.Events[3]);
 310                 }
 311
 312                 /// <summary>
 313                 /// collects events in an array list, used for ensuring we are cleaning up the parent kernel
 314                 /// event subscriptions correctly.
 315                 /// </summary>
 316                 private class EventsCollector
 317                 {
 318                         public const string Added = "added";
 319                         public const string Removed = "removed";
 320
 321                         private ArrayList events;
 322                         private object expectedSender;
 323
 324                         public ArrayList Events
 325                         {
 326                                 get { return events; }
 327                         }
 328
 329                         public EventsCollector(object expectedSender)
 330                         {
 331                                 this.expectedSender = expectedSender;
 332                                 events = new ArrayList();
 333                         }
 334
 335                         public void AddedAsChildKernel(object sender, EventArgs e)
 336                         {
 337                                 Assert.AreEqual(expectedSender, sender);
 338                                 events.Add(Added);
 339                         }
 340
 341                         public void RemovedAsChildKernel(object sender, EventArgs e)
 342                         {
 343                                 Assert.AreEqual(expectedSender, sender);
 344                                 events.Add(Removed);
 345                         }
 346                 }
 347
 348                 public class Component
 349                 {
 350                         public Component(IService service)
 351                         {
 352                         }
 353                 }
 354
 355                 public interface IService
 356                 {
 357                 }
 358
 359                 public class Service : IService
 360                 {
 361                         public Service()
 362                         {
 363                         }
 364                 }
 365         }
 366 }