File: EnvTestBase.java

package info (click to toggle)
openjdk-21 21.0.8%2B9-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 823,976 kB
  • sloc: java: 5,613,338; xml: 1,643,607; cpp: 1,296,296; ansic: 420,291; asm: 404,850; objc: 20,994; sh: 15,271; javascript: 11,245; python: 6,895; makefile: 2,362; perl: 357; awk: 351; sed: 172; jsp: 24; csh: 3
file content (159 lines) | stat: -rw-r--r-- 5,665 bytes parent folder | download | duplicates (19)
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
/*
 * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

import javax.naming.Context;
import javax.naming.NamingException;
import javax.naming.directory.Attributes;
import java.util.Hashtable;

/**
 * Abstract test base for most of Env Tests, this class extends DNSTestBase.
 *
 * @see DNSTestBase
 * @see TestBase
 */
abstract class EnvTestBase extends DNSTestBase {
    private static final String[] MANDATORY_ATTRIBUTES = { "A", "MX", "HINFO",
            "TXT", "29" };
    private static final String[] OPTIONAL_ATTRIBUTES = {};

    private String key;
    private String fqdnUrl;
    private String foreignFqdnUrl;

    public EnvTestBase() {
        // set default test data
        setKey("host1");
    }

    /**
     * Setup test before real test run, it overrides the method of TestBase.
     */
    @Override public void setupTest() {
        super.setupTest();
        String fqdn = DNSTestUtils.buildFqdn(key, env(), true);

        String foreignLeaf = (String) env().get("FOREIGN_LEAF");
        String foreignFqdn = DNSTestUtils.buildFqdn(foreignLeaf, env(), false);

        fqdnUrl = DNSTestUtils.getRootUrl(env()) + "/" + fqdn;
        foreignFqdnUrl = DNSTestUtils.getRootUrl(env()) + "/" + foreignFqdn;
    }

    /**
     * Overload method of addToEnvAndVerifyOldValIsNull, use context() as
     * context.
     *
     * @param propName given property name
     * @param propVal  given property value
     * @throws NamingException if a naming exception is encountered
     */
    public void addToEnvAndVerifyOldValIsNull(String propName, Object propVal)
            throws NamingException {
        addToEnvAndVerifyOldValIsNull(context(), propName, propVal);
    }

    /**
     * Add given property name/value to the environment of given context and
     * verify the previous old property value is null which means the property
     * was not in the environment before.
     *
     * @param context  given context
     * @param propName given property name
     * @param propVal  given property value
     * @throws NamingException if a naming exception is encountered
     */
    public void addToEnvAndVerifyOldValIsNull(Context context, String propName,
            Object propVal) throws NamingException {
        Object oldValue = context.addToEnvironment(propName, propVal);
        DNSTestUtils.debug("Old Value for " + propName + " : " + oldValue);
        if (oldValue != null) {
            throw new RuntimeException(
                    "Failed: old value expected to be null for " + propName
                            + " but actual is : " + oldValue);
        }
    }

    /**
     * Verify the value of specified property in given environment matched with
     * given expected value. If property not exist and given expected value is
     * null, we think verify passed. RuntimeException will be thrown if verify
     * failed.
     *
     * @param env         given environment
     * @param propName    given property name to verify
     * @param expectedVal expected property value
     */
    public void verifyEnvProperty(Hashtable<?, ?> env, String propName,
            Object expectedVal) {
        boolean equals = true;
        Object actualVal = env.get(propName);
        if (actualVal != null && expectedVal != null) {
            if (!expectedVal.equals(actualVal)) {
                equals = false;
            }
        } else {
            if (actualVal != null || expectedVal != null) {
                equals = false;
            }
        }

        if (!equals) {
            throw new RuntimeException(
                    "Failed: value not match for " + propName + " expected: "
                            + expectedVal + " actual: " + actualVal);
        }
    }

    /**
     * Retrieve attributes by given name and attributes ids and verify
     * attributes contains the mandatory attributes and the right
     * objectclass attribute, will throw RuntimeException if verify failed.
     *
     * @param name    given name
     * @param attrIds given attribute ids
     * @throws NamingException if a naming exception is encountered
     */
    public void retrieveAndVerifyData(String name, String[] attrIds)
            throws NamingException {
        Attributes retAttrs = context().getAttributes(name, attrIds);
        DNSTestUtils.verifySchema(retAttrs, MANDATORY_ATTRIBUTES,
                OPTIONAL_ATTRIBUTES);
    }

    public String getKey() {
        return key;
    }

    public void setKey(String key) {
        this.key = key;
    }

    public String getFqdnUrl() {
        return fqdnUrl;
    }

    public String getForeignFqdnUrl() {
        return foreignFqdnUrl;
    }
}