summaryrefslogtreecommitdiff
path: root/java/broker/src/test/java/org/apache/qpid/server/logging/actors/ManagementActorTest.java
blob: a0bfa592db01429bf2885e81822e6370ddea44cb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 */
package org.apache.qpid.server.logging.actors;

import javax.security.auth.Subject;

import org.apache.qpid.server.security.auth.TestPrincipalUtils;

import java.security.PrivilegedAction;
import java.util.List;

public class ManagementActorTest extends BaseActorTestCase
{

    private static final String IP = "127.0.0.1";
    private static final String CONNECTION_ID = "1";
    private String _threadName;

    @Override
    public void setUp() throws Exception
    {
        super.setUp();
        setAmqpActor(new ManagementActor(getRootLogger()));

        // Set the thread name to be the same as a RMI JMX Connection would use
        _threadName = Thread.currentThread().getName();
        Thread.currentThread().setName("RMI TCP Connection(" + CONNECTION_ID + ")-" + IP);
    }

    @Override
    public void tearDown() throws Exception
    {
        Thread.currentThread().setName(_threadName);
        super.tearDown();
    }

    /**
     * Test the AMQPActor logging as a Connection level.
     *
     * The test sends a message then verifies that it entered the logs.
     *
     * The log message should be fully replaced (no '{n}' values) and should
     * not contain any channel identification.
     */
    public void testConnection()
    {
        final String message = sendTestLogMessage(getAmqpActor());

        List<Object> logs = getRawLogger().getLogMessages();

        assertEquals("Message log size not as expected.", 1, logs.size());

        // Verify that the logged message is present in the output
        assertTrue("Message was not found in log message",
                   logs.get(0).toString().contains(message));

        // Verify that all the values were presented to the MessageFormatter
        // so we will not end up with '{n}' entries in the log.
        assertFalse("Verify that the string does not contain any '{'.",
                    logs.get(0).toString().contains("{"));

        // Verify that the message has the correct type
        assertTrue("Message does not contain the [mng: prefix",
                   logs.get(0).toString().contains("[mng:"));

        // Verify that the logged message does not contains the 'ch:' marker
        assertFalse("Message was logged with a channel identifier." + logs.get(0),
                    logs.get(0).toString().contains("/ch:"));

        // Verify that the message has the right values
        assertTrue("Message contains the [mng: prefix",
                   logs.get(0).toString().contains("[mng:N/A(" + IP + ")"));
    }

    /**
     * Tests appearance of principal name in log message
     */
    public void testSubjectPrincipalNameAppearance()
    {
        Subject subject = TestPrincipalUtils.createTestSubject("guest");

        final String message = Subject.doAs(subject, new PrivilegedAction<String>()
        {
            public String run()
            {
                return sendTestLogMessage(getAmqpActor());
            }
        });

        // Verify that the log message was created
        assertNotNull("Test log message is not created!", message);

        List<Object> logs = getRawLogger().getLogMessages();

        // Verify that at least one log message was added to log
        assertEquals("Message log size not as expected.", 1, logs.size());

        String logMessage = logs.get(0).toString();

        // Verify that the logged message is present in the output
        assertTrue("Message was not found in log message", logMessage.contains(message));

        // Verify that the message has the right principal value
        assertTrue("Message contains the [mng: prefix", logMessage.contains("[mng:guest(" + IP + ")"));
    }

    public void testGetLogMessageWithSubject()
    {
        assertLogMessageInRMIThreadWithPrincipal("RMI TCP Connection(" + CONNECTION_ID + ")-" + IP, "my_principal");
    }

    public void testGetLogMessageWithoutSubjectButWithActorPrincipal()
    {
        String principalName = "my_principal";
        setAmqpActor(new ManagementActor(getRootLogger(), principalName));
        String message = getAmqpActor().getLogMessage();
        assertEquals("Unexpected log message", "[mng:" + principalName + "(" + IP + ")] ", message);
    }

    /** It's necessary to test successive calls because ManagementActor caches its log message based on thread and principal name */
    public void testGetLogMessageCaching()
    {
        String originalThreadName = "RMI TCP Connection(1)-" + IP;
        assertLogMessageInRMIThreadWithoutPrincipal(originalThreadName);
        assertLogMessageInRMIThreadWithPrincipal(originalThreadName, "my_principal");
        assertLogMessageInRMIThreadWithPrincipal("RMI TCP Connection(2)-" + IP, "my_principal");
    }

    public void testGetLogMessageAfterRemovingSubject()
    {
        assertLogMessageInRMIThreadWithPrincipal("RMI TCP Connection(1)-" + IP, "my_principal");

        Thread.currentThread().setName("RMI TCP Connection(2)-" + IP );
        String message = getAmqpActor().getLogMessage();
        assertEquals("Unexpected log message", "[mng:N/A(" + IP + ")] ", message);

        assertLogMessageWithoutPrincipal("TEST");
    }

    private void assertLogMessageInRMIThreadWithoutPrincipal(String threadName)
    {
        Thread.currentThread().setName(threadName );
        String message = getAmqpActor().getLogMessage();
        assertEquals("Unexpected log message", "[mng:N/A(" + IP + ")] ", message);
    }

    private void assertLogMessageWithoutPrincipal(String threadName)
    {
        Thread.currentThread().setName(threadName );
        String message = getAmqpActor().getLogMessage();
        assertEquals("Unexpected log message", "[" + threadName +"] ", message);
    }

    private void assertLogMessageInRMIThreadWithPrincipal(String threadName, String principalName)
    {
        Thread.currentThread().setName(threadName);
        Subject subject = TestPrincipalUtils.createTestSubject(principalName);
        final String message = Subject.doAs(subject, new PrivilegedAction<String>()
        {
            public String run()
            {
                return getAmqpActor().getLogMessage();
            }
        });

        assertEquals("Unexpected log message", "[mng:" + principalName + "(" + IP + ")] ", message);
    }
}