This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

View | Details | Raw Unified | Return to bug 253570
Collapse All | Expand All

(-)a/php.codeception/src/org/netbeans/modules/php/codeception/ImportantFilesImpl.java (+128 lines)
Line 0 Link Here
1
/*
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3
 *
4
 * Copyright 2015 Oracle and/or its affiliates. All rights reserved.
5
 *
6
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7
 * Other names may be trademarks of their respective owners.
8
 *
9
 * The contents of this file are subject to the terms of either the GNU
10
 * General Public License Version 2 only ("GPL") or the Common
11
 * Development and Distribution License("CDDL") (collectively, the
12
 * "License"). You may not use this file except in compliance with the
13
 * License. You can obtain a copy of the License at
14
 * http://www.netbeans.org/cddl-gplv2.html
15
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
16
 * specific language governing permissions and limitations under the
17
 * License.  When distributing the software, include this License Header
18
 * Notice in each file and include the License file at
19
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
20
 * particular file as subject to the "Classpath" exception as provided
21
 * by Oracle in the GPL Version 2 section of the License file that
22
 * accompanied this code. If applicable, add the following below the
23
 * License Header, with the fields enclosed by brackets [] replaced by
24
 * your own identifying information:
25
 * "Portions Copyrighted [year] [name of copyright owner]"
26
 *
27
 * If you wish your version of this file to be governed by only the CDDL
28
 * or only the GPL Version 2, indicate your decision by adding
29
 * "[Contributor] elects to include this software in this distribution
30
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
31
 * single choice of license, a recipient has the option to distribute
32
 * your version of this file under either the CDDL, the GPL Version 2 or
33
 * to extend the choice of license to its licensees as provided above.
34
 * However, if you add GPL Version 2 code and therefore, elected the GPL
35
 * Version 2 license, then the option applies only if the new code is
36
 * made subject to such option by the copyright holder.
37
 *
38
 * Contributor(s):
39
 *
40
 * Portions Copyrighted 2015 Sun Microsystems, Inc.
41
 */
42
package org.netbeans.modules.php.codeception;
43
44
import java.util.ArrayList;
45
import java.util.Collection;
46
import java.util.Collections;
47
import java.util.List;
48
import java.util.prefs.PreferenceChangeEvent;
49
import java.util.prefs.PreferenceChangeListener;
50
import javax.swing.event.ChangeListener;
51
import org.netbeans.api.project.Project;
52
import org.netbeans.modules.php.api.phpmodule.PhpModule;
53
import org.netbeans.modules.php.codeception.commands.Codecept;
54
import org.netbeans.modules.php.codeception.preferences.CodeceptionPreferences;
55
import org.netbeans.modules.php.spi.phpmodule.ImportantFilesImplementation;
56
import org.netbeans.modules.php.spi.phpmodule.ImportantFilesSupport;
57
import org.netbeans.spi.project.ProjectServiceProvider;
58
import org.openide.filesystems.FileObject;
59
import org.openide.util.ChangeSupport;
60
import org.openide.util.WeakListeners;
61
62
public final class ImportantFilesImpl implements ImportantFilesImplementation, PreferenceChangeListener {
63
64
    private final Project project;
65
    private final ChangeSupport changeSupport = new ChangeSupport(this);
66
    private final ImportantFilesSupport defaultConfigSupport;
67
    private boolean initialized = false;
68
69
    private ImportantFilesImpl(Project project) {
70
        assert project != null;
71
        this.project = project;
72
        defaultConfigSupport = ImportantFilesSupport.create(project.getProjectDirectory(), Codecept.CODECEPTION_CONFIG_FILE_NAME);
73
    }
74
75
    @ProjectServiceProvider(service = ImportantFilesImplementation.class, projectType = "org-netbeans-modules-php-project") // NOI18N
76
    public static ImportantFilesImplementation createImpotantFiles(Project project) {
77
        ImportantFilesImpl importantFiles = new ImportantFilesImpl(project);
78
        return importantFiles;
79
    }
80
81
    @Override
82
    public Collection<FileInfo> getFiles() {
83
        PhpModule phpModule = PhpModule.Factory.lookupPhpModule(project);
84
        if (phpModule == null) {
85
            return Collections.emptyList();
86
        }
87
        if (!initialized) {
88
            initialized = true;
89
            CodeceptionPreferences.addPreferenceChangeListener(phpModule, WeakListeners.create(PreferenceChangeListener.class, this, CodeceptionPreferences.class));
90
        }
91
92
        // global configuration
93
        List<FileInfo> files = new ArrayList<>();
94
        files.addAll(defaultConfigSupport.getFiles(null));
95
        if (CodeceptionPreferences.isCustomCodeceptionYmlEnabled(phpModule)) {
96
            FileObject codeceptionYml = Codecept.getCodeceptionYml(phpModule);
97
            if (codeceptionYml != null) {
98
                files.add(new FileInfo(codeceptionYml));
99
            }
100
        }
101
        return files;
102
    }
103
104
    @Override
105
    public void addChangeListener(ChangeListener listener) {
106
        changeSupport.addChangeListener(listener);
107
        defaultConfigSupport.addChangeListener(listener);
108
    }
109
110
    @Override
111
    public void removeChangeListener(ChangeListener listener) {
112
        changeSupport.removeChangeListener(listener);
113
        defaultConfigSupport.removeChangeListener(listener);
114
    }
115
116
    @Override
117
    public void preferenceChange(PreferenceChangeEvent evt) {
118
        if (CodeceptionPreferences.CUSTOM_CODECEPTION_YML_PATH.equals(evt.getKey())
119
                || CodeceptionPreferences.CUSTOM_CODECEPTION_YML_ENABLED.equals(evt.getKey())) {
120
            fireChange();
121
        }
122
    }
123
124
    void fireChange() {
125
        changeSupport.fireChange();
126
    }
127
128
}
(-)a/php.codeception/src/org/netbeans/modules/php/codeception/commands/Codecept.java (-3 / +3 lines)
Lines 134-139 Link Here
134
    private static final String CEST_FILE_SUFFIX = CEST_CLASS_SUFFIX + ".php"; // NOI18N
134
    private static final String CEST_FILE_SUFFIX = CEST_CLASS_SUFFIX + ".php"; // NOI18N
135
    public static final String CEPT_CLASS_SUFFIX = "Cept"; // NOI18N
135
    public static final String CEPT_CLASS_SUFFIX = "Cept"; // NOI18N
136
    private static final String CEPT_FILE_SUFFIX = CEPT_CLASS_SUFFIX + ".php"; // NOI18N
136
    private static final String CEPT_FILE_SUFFIX = CEPT_CLASS_SUFFIX + ".php"; // NOI18N
137
    private static final String SUITE_CONFIG_SUFFIX = ".suite.yml"; // NOI18N
137
    // test method prefix
138
    // test method prefix
138
    public static final String TEST_METHOD_PREFIX = "test"; // NOI18N
139
    public static final String TEST_METHOD_PREFIX = "test"; // NOI18N
139
140
Lines 506-517 Link Here
506
    }
507
    }
507
508
508
    @CheckForNull
509
    @CheckForNull
509
    public FileObject getCodeceptionYml(PhpModule phpModule) {
510
    public static FileObject getCodeceptionYml(PhpModule phpModule) {
510
        if (phpModule == null) {
511
        if (phpModule == null) {
511
            return null;
512
            return null;
512
        }
513
        }
513
        // custom
514
        // custom
514
        // XXX allow only the source directory?
515
        // A PHP Framework may have a codeception.yml in an inner directory.
515
        // A PHP Framework may have a codeception.yml in an inner directory.
516
        // e.g. In case of Yii2 framework, source/tests/codeception.yml
516
        // e.g. In case of Yii2 framework, source/tests/codeception.yml
517
        if (CodeceptionPreferences.isCustomCodeceptionYmlEnabled(phpModule)) {
517
        if (CodeceptionPreferences.isCustomCodeceptionYmlEnabled(phpModule)) {
Lines 557-563 Link Here
557
                    continue;
557
                    continue;
558
                }
558
                }
559
                String name = child.getNameExt();
559
                String name = child.getNameExt();
560
                int lastIndexOfSuiteSuffix = name.lastIndexOf(".suite.yml"); // NOI18N
560
                int lastIndexOfSuiteSuffix = name.lastIndexOf(SUITE_CONFIG_SUFFIX);
561
                if (lastIndexOfSuiteSuffix != -1) {
561
                if (lastIndexOfSuiteSuffix != -1) {
562
                    suites.add(name.substring(0, lastIndexOfSuiteSuffix));
562
                    suites.add(name.substring(0, lastIndexOfSuiteSuffix));
563
                }
563
                }
(-)a/php.codeception/src/org/netbeans/modules/php/codeception/preferences/CodeceptionPreferences.java (-3 / +24 lines)
Lines 42-47 Link Here
42
package org.netbeans.modules.php.codeception.preferences;
42
package org.netbeans.modules.php.codeception.preferences;
43
43
44
import java.io.File;
44
import java.io.File;
45
import java.util.concurrent.ConcurrentHashMap;
46
import java.util.concurrent.ConcurrentMap;
47
import java.util.prefs.PreferenceChangeListener;
45
import java.util.prefs.Preferences;
48
import java.util.prefs.Preferences;
46
import org.netbeans.api.annotations.common.CheckForNull;
49
import org.netbeans.api.annotations.common.CheckForNull;
47
import org.netbeans.modules.php.api.phpmodule.PhpModule;
50
import org.netbeans.modules.php.api.phpmodule.PhpModule;
Lines 54-63 Link Here
54
57
55
    private static final String CUSTOM_CODECEPT_ENABLED = "custom.codecept.enabled"; // NOI18N
58
    private static final String CUSTOM_CODECEPT_ENABLED = "custom.codecept.enabled"; // NOI18N
56
    private static final String CUSTOM_CODECEPT_PATH = "custom.codecept.path"; // NOI18N
59
    private static final String CUSTOM_CODECEPT_PATH = "custom.codecept.path"; // NOI18N
57
    private static final String CUSTOM_CODECEPTION_YML_ENABLED = "custom.codeception.yml.enabled"; // NOI18N
60
    public static final String CUSTOM_CODECEPTION_YML_ENABLED = "custom.codeception.yml.enabled"; // NOI18N
58
    private static final String CUSTOM_CODECEPTION_YML_PATH = "custom.codeception.yml.path"; // NOI18N
61
    public static final String CUSTOM_CODECEPTION_YML_PATH = "custom.codeception.yml.path"; // NOI18N
59
    private static final String ASK_FOR_ADDITIONAL_PARAMS = "additional.params.ask"; // NOI18N
62
    private static final String ASK_FOR_ADDITIONAL_PARAMS = "additional.params.ask"; // NOI18N
60
63
64
    private static final ConcurrentMap<PhpModule, Preferences> CACHE = new ConcurrentHashMap<>();
61
65
62
    private CodeceptionPreferences() {
66
    private CodeceptionPreferences() {
63
    }
67
    }
Lines 104-111 Link Here
104
        getPreference(phpModule).putBoolean(ASK_FOR_ADDITIONAL_PARAMS, ask);
108
        getPreference(phpModule).putBoolean(ASK_FOR_ADDITIONAL_PARAMS, ask);
105
    }
109
    }
106
110
111
    public static void addPreferenceChangeListener(PhpModule phpModule, PreferenceChangeListener listener) {
112
        getPreference(phpModule).addPreferenceChangeListener(listener);
113
    }
114
115
    public static void removePreferenceChangeListener(PhpModule phpModule, PreferenceChangeListener listener) {
116
        getPreference(phpModule).removePreferenceChangeListener(listener);
117
    }
118
107
    private static Preferences getPreference(PhpModule phpModule) {
119
    private static Preferences getPreference(PhpModule phpModule) {
108
        return phpModule.getPreferences(CodeceptionTestingProvider.class, true);
120
        Preferences preferences = CACHE.get(phpModule);
121
        if (preferences == null) {
122
            preferences = phpModule.getPreferences(CodeceptionTestingProvider.class, true);
123
            Preferences currentPreferences = CACHE.putIfAbsent(phpModule, preferences);
124
            if (currentPreferences != null) {
125
                preferences = currentPreferences;
126
            }
127
        }
128
        assert preferences != null;
129
        return preferences;
109
    }
130
    }
110
131
111
    private static String relativizePath(PhpModule phpModule, String filePath) {
132
    private static String relativizePath(PhpModule phpModule, String filePath) {

Return to bug 253570