View Javadoc
1   /*
2    * Copyright (c) 2002-2025, City of Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.portal.service.includes;
35  
36  import fr.paris.lutece.portal.service.content.PageData;
37  import fr.paris.lutece.portal.service.init.LuteceInitException;
38  import fr.paris.lutece.test.LuteceTestCase;
39  
40  import java.util.List;
41  import java.util.Map;
42  
43  import javax.servlet.http.HttpServletRequest;
44  
45  public class PageIncludeServiceTest extends LuteceTestCase
46  {
47      public void testPageIncludes( )
48      {
49          List<PageInclude> listIncludes = PageIncludeService.getIncludes( );
50          // Assert default includes are loaded
51          assertTrue( listIncludes.size( ) > 2 );
52      }
53  
54      public void testEnabledState( ) throws LuteceInitException
55      {
56          PageIncludeEntry entry = new PageIncludeEntry( );
57          entry.setClassName( TestPageInclude.class.getName( ) );
58          entry.setId( "testEnablePageInclude" );
59          entry.setPluginName( "core" ); // core is an always enabled plugin
60  
61          PageIncludeService.registerPageInclude( entry );
62  
63          List<PageInclude> includes = PageIncludeService.getIncludes( );
64          assertTrue( isTestPageIncludeActive( includes ) );
65  
66          entry.setEnabled( false );
67          PageIncludeService.registerPageInclude( entry );
68          includes = PageIncludeService.getIncludes( );
69          assertFalse( isTestPageIncludeActive( includes ) );
70  
71          entry.setPluginName( "bogus_inexistant_plugin" );
72          PageIncludeService.registerPageInclude( entry );
73          includes = PageIncludeService.getIncludes( );
74          assertFalse( isTestPageIncludeActive( includes ) );
75  
76          entry.setEnabled( true );
77          PageIncludeService.registerPageInclude( entry );
78          includes = PageIncludeService.getIncludes( );
79          assertFalse( isTestPageIncludeActive( includes ) );
80      }
81  
82      private boolean isTestPageIncludeActive( List<PageInclude> includes )
83      {
84          boolean found = false;
85  
86          for ( PageInclude include : includes )
87          {
88              if ( include instanceof TestPageInclude )
89              {
90                  found = true;
91  
92                  break;
93              }
94          }
95  
96          return found;
97      }
98  
99      static class TestPageInclude implements PageInclude
100     {
101         @Override
102         public void fillTemplate( Map<String, Object> rootModel, PageData data, int nMode, HttpServletRequest request )
103         {
104         }
105     }
106 }