Permalink
Browse files

Initial public release

  • Loading branch information...
0 parents commit 54fcf8a467a05cf00b5508aad392999186ecd049 @jwills jwills committed Nov 12, 2013
Showing with 6,924 additions and 0 deletions.
  1. +8 −0 .gitignore
  2. +72 −0 LICENSE.txt
  3. +37 −0 README.md
  4. +77 −0 avro/pom.xml
  5. +216 −0 avro/src/main/avro/experiments.avdl
  6. +363 −0 avro/src/main/java/com/cloudera/gertrude/space/AvroExperimentSpaceDeserializer.java
  7. +138 −0 avro/src/test/java/com/cloudera/gertrude/space/AvroDataUtils.java
  8. +252 −0 avro/src/test/java/com/cloudera/gertrude/space/AvroExperimentSpaceDeserializerTest.java
  9. +67 −0 core/pom.xml
  10. +90 −0 core/src/main/java/com/cloudera/gertrude/AbstractExperimentState.java
  11. +146 −0 core/src/main/java/com/cloudera/gertrude/Condition.java
  12. +43 −0 core/src/main/java/com/cloudera/gertrude/ConditionFactory.java
  13. +107 −0 core/src/main/java/com/cloudera/gertrude/DiversionCriterion.java
  14. +112 −0 core/src/main/java/com/cloudera/gertrude/ExperimentFlag.java
  15. +92 −0 core/src/main/java/com/cloudera/gertrude/ExperimentFlagSettings.java
  16. +103 −0 core/src/main/java/com/cloudera/gertrude/ExperimentHandler.java
  17. +147 −0 core/src/main/java/com/cloudera/gertrude/ExperimentSpace.java
  18. +83 −0 core/src/main/java/com/cloudera/gertrude/ExperimentSpaceDeserializer.java
  19. +74 −0 core/src/main/java/com/cloudera/gertrude/ExperimentSpaceLoader.java
  20. +116 −0 core/src/main/java/com/cloudera/gertrude/ExperimentState.java
  21. +208 −0 core/src/main/java/com/cloudera/gertrude/Experiments.java
  22. +78 −0 core/src/main/java/com/cloudera/gertrude/FlagTypeParser.java
  23. +86 −0 core/src/main/java/com/cloudera/gertrude/FlagValue.java
  24. +33 −0 core/src/main/java/com/cloudera/gertrude/FlagValueCalculator.java
  25. +54 −0 core/src/main/java/com/cloudera/gertrude/Layer.java
  26. +79 −0 core/src/main/java/com/cloudera/gertrude/Segment.java
  27. +191 −0 core/src/main/java/com/cloudera/gertrude/calculate/AssociativeOperator.java
  28. +88 −0 core/src/main/java/com/cloudera/gertrude/calculate/BasicModifier.java
  29. +72 −0 core/src/main/java/com/cloudera/gertrude/calculate/FlagValueCalculatorImpl.java
  30. +59 −0 core/src/main/java/com/cloudera/gertrude/calculate/FlagValueOverride.java
  31. +22 −0 core/src/main/java/com/cloudera/gertrude/calculate/Modifier.java
  32. +62 −0 core/src/main/java/com/cloudera/gertrude/condition/AbstractPropertyCondition.java
  33. +128 −0 core/src/main/java/com/cloudera/gertrude/condition/BooleanConditions.java
  34. +53 −0 core/src/main/java/com/cloudera/gertrude/condition/CompositeConditionFactory.java
  35. +51 −0 core/src/main/java/com/cloudera/gertrude/condition/ReflectionConditionFactory.java
  36. +67 −0 core/src/main/java/com/cloudera/gertrude/space/Domain.java
  37. +91 −0 core/src/main/java/com/cloudera/gertrude/space/ExperimentInfo.java
  38. +199 −0 core/src/main/java/com/cloudera/gertrude/space/ExperimentSpaceBuilder.java
  39. +31 −0 core/src/main/java/com/cloudera/gertrude/space/FlagValueData.java
  40. +181 −0 core/src/main/java/com/cloudera/gertrude/space/LayerBuilder.java
  41. +138 −0 core/src/main/java/com/cloudera/gertrude/space/LayerImpl.java
  42. +103 −0 core/src/main/java/com/cloudera/gertrude/space/LayerInfo.java
  43. +62 −0 core/src/main/java/com/cloudera/gertrude/space/SegmentInfo.java
  44. +56 −0 core/src/test/java/com/cloudera/gertrude/TestCondition.java
  45. +44 −0 core/src/test/java/com/cloudera/gertrude/TestConditionFactory.java
  46. +39 −0 core/src/test/java/com/cloudera/gertrude/TestExperimentSpaceDeserializer.java
  47. +64 −0 core/src/test/java/com/cloudera/gertrude/TestExperimentSpaceLoader.java
  48. +64 −0 core/src/test/java/com/cloudera/gertrude/TestExperimentState.java
  49. +52 −0 core/src/test/java/com/cloudera/gertrude/TestExperiments.java
  50. +51 −0 core/src/test/java/com/cloudera/gertrude/calculate/BasicModifierTest.java
  51. +43 −0 core/src/test/java/com/cloudera/gertrude/calculate/FlagValueCalculatorTest.java
  52. +60 −0 core/src/test/java/com/cloudera/gertrude/calculate/FlagValueOverrideTest.java
  53. +50 −0 core/src/test/java/com/cloudera/gertrude/condition/BooleanConditionsTest.java
  54. +83 −0 core/src/test/java/com/cloudera/gertrude/condition/ConditionsTest.java
  55. +99 −0 core/src/test/java/com/cloudera/gertrude/defaults/DefaultSettingsTest.java
  56. +79 −0 curator/pom.xml
  57. +60 −0 curator/src/main/java/com/cloudera/gertrude/curator/NodeCacheExperimentSpaceLoader.java
  58. +72 −0 curator/src/test/java/com/cloudera/gertrude/curator/NodeCacheExperimentSpaceLoaderTest.java
  59. +121 −0 deploy/pom.xml
  60. +230 −0 deploy/src/main/java/com/cloudera/gertrude/deploy/AvroSupport.java
  61. +54 −0 deploy/src/main/java/com/cloudera/gertrude/deploy/CuratorSupport.java
  62. +66 −0 deploy/src/main/java/com/cloudera/gertrude/deploy/Cyclone.java
  63. +44 −0 deploy/src/test/com/cloudera/gertrude/deploy/DeployTest.java
  64. +178 −0 deploy/src/test/resources/gertrude.conf
  65. +73 −0 file/pom.xml
  66. +72 −0 file/src/main/java/com/cloudera/gertrude/file/FileExperimentSpaceLoader.java
  67. +60 −0 file/src/test/java/com/cloudera/gertrude/file/FileExperimentSpaceLoaderTest.java
  68. +225 −0 pom.xml
  69. +79 −0 server/pom.xml
  70. +54 −0 server/src/main/java/com/cloudera/gertrude/server/ExampleServlet.java
  71. +74 −0 server/src/main/java/com/cloudera/gertrude/server/GertrudeFilter.java
  72. +52 −0 server/src/main/java/com/cloudera/gertrude/server/GertrudeUtils.java
  73. +22 −0 server/src/main/java/com/cloudera/gertrude/server/HttpServletExperimentState.java
  74. +64 −0 server/src/main/java/com/cloudera/gertrude/server/HttpServletExperimentStateImpl.java
  75. +61 −0 server/src/main/java/com/cloudera/gertrude/server/condition/IntHeaderCondition.java
@@ -0,0 +1,8 @@
+.classpath
+.project
+.settings
+.cache
+target
+*.iml
+.idea
+gen
@@ -0,0 +1,72 @@
+Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed 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.
@@ -0,0 +1,37 @@
+Gertrude: A Multilayer and Multivariate Experiment Framework for the JVM
+------------------------------------------------------------------------
+
+Gertrude is a Java implementation of the overlapping experiments infrastructure used at
+Google and first described in [Tang et al. (2010)](http://research.google.com/pubs/pub36500.html).
+It is designed to be powerful enough to support the types of experiments that data scientists,
+machine learning researchers, and software engineers need to run when developing _data products_
+(e.g., recommendation engines, search ranking algorithms, and large-scale classifiers), although
+it can also be used for testing new features and UI treatments.
+
+The core of Gertrude is a Java library that allows developers to add _experiment flags_ to their
+code to control the value of certain scalar parameters (booleans, ints, doubles, and strings) and
+an external _configuration file_ that defines rules for setting the values of experiment flags on
+every request to the server based on attributes of the request (such as a user's cookie or anonymous
+login id.)
+
+Gertrude has minimal dependencies and is intended to be used as a component library for production
+servers. The components of the framework are:
+
+* **core**: Core API definitions and experiment diversion logic
+* **avro**: Support for serializing experiment configurations as Apache Avro records
+* **curator**: Support for loading experiment configurations via Apache Curator, a library of
+patterns for Apache Zookeeper
+* **file**: Support for loading experiment configurations from a file that is monitored for changes
+* **server**: Example code for creating core experiment classes and configuring them for use with
+a Java server, a good place to start to see how the framework is used
+* **deploy**: Simple commandline tool for parsing an experiment configuration from a JSON or
+[HOCON](https://github.com/typesafehub/config) file, serializing it as an Avro object, and then
+deploying the serialized object to a Zookeeper node or file.
+
+Gertrude is alpha code and is under active development, and we welcome new contributors. We will
+be co-developing Gertrude with [Oryx](http://github.com/cloudera/oryx), but Gertrude will remain
+a stand-alone library.
+
+Gertrude is named for [Gertrude Cox](http://en.wikipedia.org/wiki/Gertrude_Mary_Cox), the founder of
+the department of Experimental Statistics at North Carolina State University and co-author of one of the classic texts
+in the field, [Experimental Designs](http://www.amazon.com/Experimental-Designs-Edition-William-Cochran/dp/0471545678).
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2013, Cloudera, Inc. All Rights Reserved.
+
+ Cloudera, Inc. 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
+
+ This software 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.
+ -->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>com.cloudera.gertrude</groupId>
+ <artifactId>gertrude-parent</artifactId>
+ <version>0.1.0</version>
+ <relativePath>../</relativePath>
+ </parent>
+
+ <artifactId>gertrude-avro</artifactId>
+ <name>Gertrude Experiment Framework Avro Support</name>
+
+ <dependencies>
+ <dependency>
+ <groupId>com.cloudera.gertrude</groupId>
+ <artifactId>gertrude-core</artifactId>
+ </dependency>
+
+ <dependency>
+ <groupId>com.google.guava</groupId>
+ <artifactId>guava</artifactId>
+ </dependency>
+
+ <dependency>
+ <groupId>org.apache.avro</groupId>
+ <artifactId>avro</artifactId>
+ </dependency>
+
+ <dependency>
+ <groupId>com.cloudera.gertrude</groupId>
+ <artifactId>gertrude-core</artifactId>
+ <type>test-jar</type>
+ <scope>test</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-compiler-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.avro</groupId>
+ <artifactId>avro-maven-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-surefire-plugin</artifactId>
+ </plugin>
+ </plugins>
+ </build>
+</project>
+
Oops, something went wrong.

0 comments on commit 54fcf8a

Please sign in to comment.