View Javadoc
1   // ******************************************************************************
2   //
3   // Title:       Force Field X.
4   // Description: Force Field X - Software for Molecular Biophysics.
5   // Copyright:   Copyright (c) Michael J. Schnieders 2001-2024.
6   //
7   // This file is part of Force Field X.
8   //
9   // Force Field X is free software; you can redistribute it and/or modify it
10  // under the terms of the GNU General Public License version 3 as published by
11  // the Free Software Foundation.
12  //
13  // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14  // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15  // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16  // details.
17  //
18  // You should have received a copy of the GNU General Public License along with
19  // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20  // Place, Suite 330, Boston, MA 02111-1307 USA
21  //
22  // Linking this library statically or dynamically with other modules is making a
23  // combined work based on this library. Thus, the terms and conditions of the
24  // GNU General Public License cover the whole combination.
25  //
26  // As a special exception, the copyright holders of this library give you
27  // permission to link this library with independent modules to produce an
28  // executable, regardless of the license terms of these independent modules, and
29  // to copy and distribute the resulting executable under terms of your choice,
30  // provided that you also meet, for each linked independent module, the terms
31  // and conditions of the license of that module. An independent module is a
32  // module which is not derived from or based on this library. If you modify this
33  // library, you may extend this exception to your version of the library, but
34  // you are not obligated to do so. If you do not wish to do so, delete this
35  // exception statement from your version.
36  //
37  // ******************************************************************************
38  package ffx.algorithms.groovy;
39  
40  import ffx.algorithms.misc.AlgorithmsTest;
41  import org.junit.Test;
42  
43  /**
44   * Tests the Cluster command to assess clustering based on distances.
45   * TODO: add more tests with more parameters
46   *
47   * @author Aaron J. Nessler
48   */
49  public class ClusteringTest extends AlgorithmsTest {
50  
51    /** Tests the Cluster script. */
52    @Test
53    public void testBaseCluster() {
54      // Set-up the input arguments for the Cluster script.
55      String filepath = getResourcePath("dist.txt");
56      String[] args = {"-a", "0", "-k", "10", filepath};
57      binding.setVariable("args", args);
58      binding.setVariable("baseDir", registerTemporaryDirectory().toFile());
59  
60      // Construct and evaluate the Cluster script.
61      Cluster cluster = new Cluster(binding).run();
62      algorithmsScript = cluster;
63      // TODO validate output.
64    }
65  
66    @Test
67    public void testClusterHelp() {
68      // Set-up the input arguments for the Cluster script.
69      String[] args = {"-h"};
70      binding.setVariable("args", args);
71  
72      // Construct and evaluate the Cluster script.
73      Cluster cluster = new Cluster(binding).run();
74      algorithmsScript = cluster;
75    }
76  }