tests/club/wpia/gigi/testUtils/ManagedTest.java

   1 package club.wpia.gigi.testUtils;
   2
   3 import static org.junit.Assert.*;
   4
   5 import java.io.BufferedReader;
   6 import java.io.DataOutputStream;
   7 import java.io.IOException;
   8 import java.io.InputStreamReader;
   9 import java.io.OutputStream;
  10 import java.io.UnsupportedEncodingException;
  11 import java.net.HttpURLConnection;
  12 import java.net.InetSocketAddress;
  13 import java.net.MalformedURLException;
  14 import java.net.Socket;
  15 import java.net.URL;
  16 import java.net.URLConnection;
  17 import java.net.URLEncoder;
  18 import java.nio.file.Files;
  19 import java.nio.file.Paths;
  20 import java.security.KeyManagementException;
  21 import java.security.NoSuchAlgorithmException;
  22 import java.security.Principal;
  23 import java.security.PrivateKey;
  24 import java.security.cert.X509Certificate;
  25 import java.sql.SQLException;
  26 import java.util.Locale;
  27 import java.util.Properties;
  28 import java.util.regex.Matcher;
  29 import java.util.regex.Pattern;
  30
  31 import javax.net.ssl.HttpsURLConnection;
  32 import javax.net.ssl.KeyManager;
  33 import javax.net.ssl.SSLContext;
  34 import javax.net.ssl.X509KeyManager;
  35
  36 import org.hamcrest.CoreMatchers;
  37 import org.junit.After;
  38 import org.junit.AfterClass;
  39 import org.junit.BeforeClass;
  40
  41 import club.wpia.gigi.DevelLauncher;
  42 import club.wpia.gigi.GigiApiException;
  43 import club.wpia.gigi.database.GigiPreparedStatement;
  44 import club.wpia.gigi.database.GigiResultSet;
  45 import club.wpia.gigi.dbObjects.EmailAddress;
  46 import club.wpia.gigi.dbObjects.Group;
  47 import club.wpia.gigi.dbObjects.Job;
  48 import club.wpia.gigi.dbObjects.ObjectCache;
  49 import club.wpia.gigi.dbObjects.User;
  50 import club.wpia.gigi.pages.account.MyDetails;
  51 import club.wpia.gigi.pages.main.RegisterPage;
  52 import club.wpia.gigi.testUtils.TestEmailReceiver.TestMail;
  53 import club.wpia.gigi.util.SimpleSigner;
  54
  55 /**
  56  * Base class for test suites who require a launched Gigi instance. The instance
  57  * is cleared once per test suite.
  58  */
  59 public class ManagedTest extends ConfiguredTest {
  60
  61     static {
  62         System.setProperty("sun.net.http.allowRestrictedHeaders", "true");
  63     }
  64
  65     private static TestEmailReceiver ter;
  66
  67     private static Process gigi;
  68
  69     private static String url = "localhost:4443";
  70
  71     private static String acceptLanguage = null;
  72
  73     public static void setAcceptLanguage(String acceptLanguage) {
  74         ManagedTest.acceptLanguage = acceptLanguage;
  75     }
  76
  77     public static String getServerName() {
  78         return url.replaceFirst(":443$", "");
  79     }
  80
  81     public static String getSecureServerName() {
  82         return getServerName().replaceAll("^www\\.", "secure.");
  83     }
  84
  85     static {
  86         InitTruststore.run();
  87         HttpURLConnection.setFollowRedirects(false);
  88     }
  89
  90     @BeforeClass
  91     public static void initEnvironmentHook() {
  92         initEnvironment();
  93     }
  94
  95     private static boolean inited = false;
  96
  97     public static Properties initEnvironment() {
  98         try {
  99             Properties mainProps = ConfiguredTest.initEnvironment();
 100             if (inited) {
 101                 return mainProps;
 102             }
 103             inited = true;
 104             url = testProps.getProperty("name.www") + ":" + testProps.getProperty("serverPort.https");
 105             purgeDatabase();
 106             String type = testProps.getProperty("type");
 107             generateMainProps(mainProps);
 108             if (type.equals("local")) {
 109                 String[] parts = testProps.getProperty("mail").split(":", 2);
 110                 ter = new TestEmailReceiver(new InetSocketAddress(parts[0], Integer.parseInt(parts[1])));
 111                 ter.start();
 112                 if (testProps.getProperty("withSigner", "false").equals("true")) {
 113                     SimpleSigner.runSigner();
 114                 }
 115                 return mainProps;
 116             }
 117             gigi = Runtime.getRuntime().exec(testProps.getProperty("java"));
 118             DataOutputStream toGigi = new DataOutputStream(gigi.getOutputStream());
 119             System.out.println("... starting server");
 120
 121             byte[] cacerts = Files.readAllBytes(Paths.get("config/cacerts.jks"));
 122             byte[] keystore = Files.readAllBytes(Paths.get("config/keystore.pkcs12"));
 123
 124             DevelLauncher.writeGigiConfig(toGigi, "changeit".getBytes("UTF-8"), "changeit".getBytes("UTF-8"), mainProps, cacerts, keystore);
 125             toGigi.flush();
 126
 127             final BufferedReader br = new BufferedReader(new InputStreamReader(gigi.getErrorStream(), "UTF-8"));
 128             String line;
 129             while ((line = br.readLine()) != null && !line.contains("System successfully started.")) {
 130                 System.err.println(line);
 131             }
 132             new Thread() {
 133
 134                 @Override
 135                 public void run() {
 136                     String line;
 137                     try {
 138                         while ((line = br.readLine()) != null) {
 139                             System.err.println(line);
 140                         }
 141                     } catch (IOException e) {
 142                         e.printStackTrace();
 143                     }
 144                 }
 145             }.start();
 146             if (line == null) {
 147                 throw new Error("Server startup failed");
 148             }
 149             ter = new TestEmailReceiver(new InetSocketAddress("localhost", 8473));
 150             ter.start();
 151             SimpleSigner.runSigner();
 152             return mainProps;
 153         } catch (IOException e) {
 154             throw new Error(e);
 155         } catch (SQLException e1) {
 156             throw new Error(e1);
 157         } catch (InterruptedException e) {
 158             throw new Error(e);
 159         }
 160
 161     }
 162
 163     protected static void await(Job j) throws InterruptedException {
 164         SimpleSigner.ping();
 165         j.waitFor(5000);
 166     }
 167
 168     public static void purgeDatabase() throws SQLException, IOException {
 169         purgeOnlyDB();
 170         if (gigi != null) {
 171             clearCaches();
 172         }
 173     }
 174
 175     public static void clearCaches() throws IOException {
 176         ObjectCache.clearAllCaches();
 177         // String type = testProps.getProperty("type");
 178         URL u = new URL("https://" + getServerName() + "/manage");
 179         URLConnection connection = u.openConnection();
 180         connection.getHeaderField("Location");
 181         connection.getInputStream().close();
 182     }
 183
 184     private static void generateMainProps(Properties mainProps) {
 185         mainProps.setProperty("testrunner", "true");
 186         mainProps.setProperty("host", "127.0.0.1");
 187
 188         mainProps.setProperty("emailProvider", "club.wpia.gigi.email.TestEmailProvider");
 189         mainProps.setProperty("emailProvider.port", "8473");
 190         mainProps.setProperty("sql.driver", testProps.getProperty("sql.driver"));
 191         mainProps.setProperty("sql.url", testProps.getProperty("sql.url"));
 192         mainProps.setProperty("sql.user", testProps.getProperty("sql.user"));
 193         mainProps.setProperty("sql.password", testProps.getProperty("sql.password"));
 194         mainProps.setProperty("testing", "true");
 195     }
 196
 197     @AfterClass
 198     public static void tearDownServer() {
 199         String type = testProps.getProperty("type");
 200         ter.destroy();
 201         if (type.equals("local")) {
 202             if (testProps.getProperty("withSigner", "false").equals("true")) {
 203                 try {
 204                     SimpleSigner.stopSigner();
 205                 } catch (InterruptedException e) {
 206                     e.printStackTrace();
 207                 }
 208             }
 209             inited = false;
 210             return;
 211         }
 212         gigi.destroy();
 213         try {
 214             SimpleSigner.stopSigner();
 215         } catch (InterruptedException e) {
 216             e.printStackTrace();
 217         }
 218         inited = false;
 219     }
 220
 221     public final String uniq = createUniqueName();
 222
 223     @After
 224     public void removeMails() {
 225         ter.reset();
 226     }
 227
 228     @After
 229     public void clearAcceptLanguage() {
 230         ManagedTest.setAcceptLanguage(null);
 231     }
 232
 233     @Override
 234     public MailReceiver getMailReceiver() {
 235         return ter;
 236     }
 237
 238     public static String runRegister(String param) throws IOException {
 239         URL regist = new URL("https://" + getServerName() + RegisterPage.PATH);
 240         HttpURLConnection uc = (HttpURLConnection) regist.openConnection();
 241         HttpURLConnection csrfConn = (HttpURLConnection) regist.openConnection();
 242         if (acceptLanguage != null) {
 243             csrfConn.setRequestProperty("Accept-Language", acceptLanguage);
 244             uc.setRequestProperty("Accept-Language", acceptLanguage);
 245         }
 246
 247         String headerField = csrfConn.getHeaderField("Set-Cookie");
 248         headerField = stripCookie(headerField);
 249
 250         String csrf = getCSRF(csrfConn);
 251         uc.addRequestProperty("Cookie", headerField);
 252         uc.setDoOutput(true);
 253         uc.getOutputStream().write((param + "&csrf=" + csrf).getBytes("UTF-8"));
 254         if (uc.getResponseCode() == 302) {
 255             return "";
 256         }
 257         String d = IOUtils.readURL(uc);
 258         return d;
 259     }
 260
 261     public static org.hamcrest.Matcher<String> hasError() {
 262         return CoreMatchers.containsString("<div class='alert alert-danger error-msgs'>");
 263     }
 264
 265     public static org.hamcrest.Matcher<String> hasNoError() {
 266         return CoreMatchers.not(hasError());
 267     }
 268
 269     public static String fetchStartErrorMessage(String d) throws IOException {
 270         String formFail = "<div class='alert alert-danger error-msgs'>";
 271         int idx = d.indexOf(formFail);
 272         if (idx == -1) {
 273             return null;
 274         }
 275         String startError = d.substring(idx + formFail.length(), idx + formFail.length() + 150).trim();
 276         return startError;
 277     }
 278
 279     public static void registerUser(String firstName, String lastName, String email, String password) {
 280         try {
 281             String query = "name-type=western&fname=" + URLEncoder.encode(firstName, "UTF-8") + "&lname=" + URLEncoder.encode(lastName, "UTF-8") + "&email=" + URLEncoder.encode(email, "UTF-8") + "&pword1=" + URLEncoder.encode(password, "UTF-8") + "&pword2=" + URLEncoder.encode(password, "UTF-8") + "&day=1&month=1&year=1910&tos_agree=1";
 282             String data = fetchStartErrorMessage(runRegister(query));
 283             assertNull(data);
 284         } catch (UnsupportedEncodingException e) {
 285             throw new Error(e);
 286         } catch (IOException e) {
 287             throw new Error(e);
 288         }
 289     }
 290
 291     public static int createVerifiedUser(String firstName, String lastName, String email, String password) {
 292         registerUser(firstName, lastName, email, password);
 293         try {
 294             ter.receive().verify();
 295
 296             try (GigiPreparedStatement ps = new GigiPreparedStatement("SELECT `id` FROM `users` WHERE `email`=?")) {
 297                 ps.setString(1, email);
 298
 299                 GigiResultSet rs = ps.executeQuery();
 300                 if (rs.next()) {
 301                     return rs.getInt(1);
 302                 }
 303             }
 304
 305             throw new Error();
 306         } catch (IOException e) {
 307             throw new Error(e);
 308         }
 309     }
 310
 311     public static void grant(User u, Group g) throws IOException, GigiApiException {
 312         u.grantGroup(getSupporter(), g);
 313         clearCaches();
 314     }
 315
 316     /**
 317      * Creates a new user with 100 Verification Points given by an (invalid)
 318      * verification.
 319      *
 320      * @param firstName
 321      *            the first name
 322      * @param lastName
 323      *            the last name
 324      * @param email
 325      *            the email
 326      * @param password
 327      *            the password
 328      * @return a new userid.
 329      */
 330     public static int createVerificationUser(String firstName, String lastName, String email, String password) {
 331         int uid = createVerifiedUser(firstName, lastName, email, password);
 332
 333         makeAgent(uid);
 334
 335         return uid;
 336     }
 337
 338     protected static String stripCookie(String headerField) {
 339         return headerField.substring(0, headerField.indexOf(';'));
 340     }
 341
 342     public static final String SECURE_REFERENCE = MyDetails.PATH;
 343
 344     public static boolean isLoggedin(String cookie) throws IOException {
 345         URL u = new URL("https://" + getServerName() + SECURE_REFERENCE);
 346         HttpURLConnection huc = (HttpURLConnection) u.openConnection();
 347         huc.addRequestProperty("Cookie", cookie);
 348         return huc.getResponseCode() == 200;
 349     }
 350
 351     public static String login(String email, String pw) throws IOException {
 352         URL u = new URL("https://" + getServerName() + "/login");
 353         HttpURLConnection huc = (HttpURLConnection) u.openConnection();
 354
 355         String csrf = getCSRF(huc);
 356         String headerField = stripCookie(huc.getHeaderField("Set-Cookie"));
 357
 358         huc = (HttpURLConnection) u.openConnection();
 359         cookie(huc, headerField);
 360         huc.setDoOutput(true);
 361         OutputStream os = huc.getOutputStream();
 362         String data = "username=" + URLEncoder.encode(email, "UTF-8") + "&password=" + URLEncoder.encode(pw, "UTF-8") + "&csrf=" + URLEncoder.encode(csrf, "UTF-8");
 363         os.write(data.getBytes("UTF-8"));
 364         os.flush();
 365         headerField = huc.getHeaderField("Set-Cookie");
 366         if (headerField == null) {
 367             return "";
 368         }
 369         if (huc.getResponseCode() != 302) {
 370             fail(fetchStartErrorMessage(IOUtils.readURL(huc)));
 371         }
 372         return stripCookie(headerField);
 373     }
 374
 375     public static String login(final PrivateKey pk, final X509Certificate ce) throws NoSuchAlgorithmException, KeyManagementException, IOException, MalformedURLException {
 376
 377         HttpURLConnection connection = (HttpURLConnection) new URL("https://" + getSecureServerName() + "/login").openConnection();
 378         authenticateClientCert(pk, ce, connection);
 379         if (connection.getResponseCode() == 302) {
 380             assertEquals("https://" + getSecureServerName() + "/", connection.getHeaderField("Location").replaceFirst(":443$", ""));
 381             return stripCookie(connection.getHeaderField("Set-Cookie"));
 382         } else {
 383             return null;
 384         }
 385     }
 386
 387     public static void authenticateClientCert(final PrivateKey pk, final X509Certificate ce, HttpURLConnection connection) throws NoSuchAlgorithmException, KeyManagementException {
 388         KeyManager km = new X509KeyManager() {
 389
 390             @Override
 391             public String chooseClientAlias(String[] arg0, Principal[] arg1, Socket arg2) {
 392                 return "client";
 393             }
 394
 395             @Override
 396             public String chooseServerAlias(String arg0, Principal[] arg1, Socket arg2) {
 397                 return null;
 398             }
 399
 400             @Override
 401             public X509Certificate[] getCertificateChain(String arg0) {
 402                 return new X509Certificate[] {
 403                         ce
 404                 };
 405             }
 406
 407             @Override
 408             public String[] getClientAliases(String arg0, Principal[] arg1) {
 409                 return new String[] {
 410                         "client"
 411                 };
 412             }
 413
 414             @Override
 415             public PrivateKey getPrivateKey(String arg0) {
 416                 if (arg0.equals("client")) {
 417                     return pk;
 418                 }
 419                 return null;
 420             }
 421
 422             @Override
 423             public String[] getServerAliases(String arg0, Principal[] arg1) {
 424                 return new String[] {
 425                         "client"
 426                 };
 427             }
 428         };
 429         SSLContext sc = SSLContext.getInstance("TLS");
 430         sc.init(new KeyManager[] {
 431                 km
 432         }, null, null);
 433         if (connection instanceof HttpsURLConnection) {
 434             ((HttpsURLConnection) connection).setSSLSocketFactory(sc.getSocketFactory());
 435         }
 436     }
 437
 438     public static String getCSRF(URLConnection u) throws IOException {
 439         return getCSRF(u, 0);
 440     }
 441
 442     public static String getCSRF(URLConnection u, int formIndex) throws IOException {
 443         String content = IOUtils.readURL(u);
 444         return getCSRF(formIndex, content);
 445     }
 446
 447     public static String getCSRF(int formIndex, String content) throws Error {
 448         Pattern p = Pattern.compile("<input type='hidden' name='csrf' value='([^']+)'>");
 449         Matcher m = p.matcher(content);
 450         for (int i = 0; i < formIndex + 1; i++) {
 451             if ( !m.find()) {
 452                 throw new Error("No CSRF Token:\n" + content);
 453             }
 454         }
 455         return m.group(1);
 456     }
 457
 458     public static String executeBasicWebInteraction(String cookie, String path, String query) throws MalformedURLException, UnsupportedEncodingException, IOException {
 459         return executeBasicWebInteraction(cookie, path, query, 0);
 460     }
 461
 462     public static String executeBasicWebInteraction(String cookie, String path, String query, int formIndex) throws IOException, MalformedURLException, UnsupportedEncodingException {
 463         HttpURLConnection uc = post(cookie, path, query, formIndex);
 464         if (uc.getResponseCode() == 302) {
 465             return null;
 466         }
 467         String error = fetchStartErrorMessage(IOUtils.readURL(uc));
 468         return error;
 469     }
 470
 471     public static HttpURLConnection post(String cookie, String path, String query, int formIndex) throws IOException, MalformedURLException, UnsupportedEncodingException {
 472         URLConnection uc = new URL("https://" + getServerName() + path).openConnection();
 473         uc.addRequestProperty("Cookie", cookie);
 474         String csrf = getCSRF(uc, formIndex);
 475
 476         uc = new URL("https://" + getServerName() + path).openConnection();
 477         uc.addRequestProperty("Cookie", cookie);
 478         uc.setDoOutput(true);
 479         OutputStream os = uc.getOutputStream();
 480         os.write(("csrf=" + URLEncoder.encode(csrf, "UTF-8") + "&" //
 481                 + query//
 482         ).getBytes("UTF-8"));
 483         os.flush();
 484         return (HttpURLConnection) uc;
 485     }
 486
 487     public static HttpURLConnection get(String cookie, String path) throws IOException {
 488         URLConnection uc = new URL("https://" + getServerName() + path).openConnection();
 489         uc.addRequestProperty("Cookie", cookie);
 490         return (HttpURLConnection) uc;
 491     }
 492
 493     public EmailAddress createVerifiedEmail(User u) throws InterruptedException, GigiApiException {
 494         return createVerifiedEmail(u, createUniqueName() + "test@test.tld");
 495     }
 496
 497     public EmailAddress createVerifiedEmail(User u, String email) throws InterruptedException, GigiApiException {
 498         EmailAddress addr = new EmailAddress(u, email, Locale.ENGLISH);
 499         TestMail testMail = getMailReceiver().receive();
 500         assertEquals(addr.getAddress(), testMail.getTo());
 501         String hash = testMail.extractLink().substring(testMail.extractLink().lastIndexOf('=') + 1);
 502         addr.verify(hash);
 503         getMailReceiver().clearMails();
 504         return addr;
 505     }
 506
 507     public static URLConnection cookie(URLConnection openConnection, String cookie) {
 508         openConnection.setRequestProperty("Cookie", cookie);
 509         return openConnection;
 510     }
 511
 512     private static User supporter;
 513
 514     public static User getSupporter() throws GigiApiException, IOException {
 515         if (supporter != null) {
 516             return supporter;
 517         }
 518         int i = createVerifiedUser("fn", "ln", createUniqueName() + "@email.com", TEST_PASSWORD);
 519         try (GigiPreparedStatement ps = new GigiPreparedStatement("INSERT INTO `user_groups` SET `user`=?, `permission`=?::`userGroup`, `grantedby`=?")) {
 520             ps.setInt(1, i);
 521             ps.setString(2, Group.SUPPORTER.getDBName());
 522             ps.setInt(3, i);
 523             ps.execute();
 524         }
 525         clearCaches();
 526         supporter = User.getById(i);
 527         return supporter;
 528     }
 529 }