Skip to content

Commit

Permalink
Merge branch 'release/1.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
@aschieweck
aschieweck committed Mar 23, 2016
2 parents 97476f7 + 5091e63 commit d4f6965
Show file tree
Hide file tree
Showing 861 changed files with 38,384 additions and 23,545 deletions.
8 changes: 2 additions & 6 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,8 @@ hs_err_pid*
# JavaScript
main/src/main/webapp/bower_components
main/src/main/webapp/node_modules
main/src/main/webapp/app/app.js
main/src/main/webapp/app/templates.js

# CSS
main/src/main/webapp/app/style.min.css
main/src/main/webapp/app/stylesheets/style.css
main/src/main/webapp/dist
main/src/main/webapp/tests/coverage

# Auto Generated Swagger Doc
main/src/main/webapp/restdocs/docs
Expand Down
191 changes: 191 additions & 0 deletions LICENSE.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@

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:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) 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

(d) 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

Copyright 2016 TU Dortmund

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.
150 changes: 102 additions & 48 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,72 +1,126 @@
Automata Learning Experience (ALEX)
===================================
<p align="center">
<img src="assets/images/logo.png" style="max-width:100%;">
</p>

Getting Started
---------------
To build ALEX [Java][], [Maven][], [Node.JS][nodejs] and the [Grunt CLI][grunt] must be installed.
If all this tools are available, the fastest and easiest way to get started is to run the following commands:
# ALEX

# the next line must only be done once!
mvn install
Automata Learning Experience (ALEX) is a web application that allows you run automated tests on web applications and JSON-based REST services using Active Automata Learning.

# start the server
cd main
mvn jetty:run
## How it works

These commands will download all required dependencies and then build ALEX.
If the build process was successful and the server has started, ALEX is available
at [localhost](http://localhost:8080/).
Let us take a look at the example of an authentication system.
For an integration test you would probably write tests using Selenium or something else that check the following behavior:

* register > login > logout _should work_
* logout _should not work_
* register > logout _should not work_
* ...

Building a Release
------------------
To create a release archive please make sure that all requirements are fulfilled and that you can successfully build
ALEX. If this is the case just run:
With increasing complexity and feature set of an application, integration tests might be hard to maintain if all possible and impossible combinations of features should be tested.
With ALEX, we follow a different, more automated approach that

mvn clean package site
mvn -P release assembly:single
1. does not require any knowledge about the implementation of an application,
2. does not require any experience in programming and
3. separates the language specific tests from the application to test.

Afterwards the *ALEX-xxx.tar.gz* and the *ALEX-xxx.tar.zip archive are created in the `target` directory.
Assume the authentication system mentioned above has the following features: _register_, _login_ and _logout_.
Then, we model each feature independent of each other using e.g. [Selenium](http://www.seleniumhq.org/).
In Active Automata Learning, this set of testable features is called **alphabet** where the elements of the alphabet are called **symbols**.
A sequence of symbols is called a **word**.

We then pass the learning alphabet to a **learner** that uses specific algorithms to create a model of the underlying application and how it behaves based on the given symbols.
Therefore, words are executed on the real system under learning and its reactions are observed.
Finally, the learner creates a **hypothesis** as an output that is modeled as a [Mealy machine](https://en.wikipedia.org/wiki/Mealy_machine).
In this example, it would hopefully look like this:

Docker
------
Another way to test and / or release ALEX involves the tool [Docker](https://www.docker.com).
Please make sure that Docker is installed on your machine and that you have the right permissions to use it.
If this is the case just run:
![Hypothesis](assets/images/hypothesis.jpg)

# the next line must only be done once!
mvn install

cd main
mvn docker:build
As it can be seen, the learner has learned the application and all features work as intended.
From here on, more symbols can be added and learned.

Afterwards a new Docker image is created and you use it like any other Docker image, e.g.

# lets take a look at all images
docker images

# run ALEX at http://localhost:8000
docker run -d -p 8000:8080 alex:1.0-SNAPSHOT
It can be that the learner has not learned the application correctly, i.e. there is a word in the model that has a different output than the actual application.
In fact, one can never be a 100% sure if the model actually represents the system under learning.
How to check for and handle these mistakes is described in the user manual.

More Documentation
------------------
Further documentation is provided through the *site* feature of maven.
To Create the documentation simply run:
If you want to know more about Active Automata Learning, you can find some resources at [Google Scholar](https://scholar.google.de/scholar?hl=de&q=active+automata+learning) or the homepage of the [LearnLib](http://learnlib.de/).

mvn site
## Installation and first login

Afterwards the documentation is in the `target/site` folders of every module.
We developed and tested ALEX using either Windows 8.1 and higher and Linux Ubuntu 14.10 and higher.
As the application runs on JAVA, any other system with an installed JVM should do fine.
We also advise to use a modern web browser like Google Chrome >= v46, Mozilla Firefox >= v42 or Microsoft Edge with JavaScript enabled in order to run the front-end properly.

After the first start, you can login as admin backend using the account below.

Maintainers
-----------
Email: *[email protected]* <br>
Password: *admin*

* [Alexander Bainczyk](mailto:[email protected])
* [Alexander Schieweck](mailto:[email protected])
#### Using the packaged version

Make sure you have Java 8 installed on your system.

1. Download the latest version from here.
2. Open a terminal and start the war archive using `java -jar ALEX.war [--port=XXXX]`
3. Open *http://localhost:8000* in a web browser

#### From source

For the Installation from the source files make sure your system matches the following system requirements:

* Java JDK 8
* Maven 3
* Node.js v4.2.* and the NPM
* Bower `npm install -g bower`
* Grunt and Grund-Cli `npm install -g grunt grunt-cli`

To install and run ALEX, execute the following commands in a directory of your choice:

1. `git clone https://github.com/LearnLib/alex.git`
2. `cd alex`
3. `mvn install [-DskipTests]`
4. `cd main`
5. `mvn spring-boot:run [-Dport=XXXX]`
6. open *http://localhost:8000* in a web browser

## Further reading

* Frontend user manual
* REST API documentation
* Screencasts
* Developer docs

## FAQs

**Is ALEX ready for production use?** <br>
ALEX has already been used by a class at the TU Dortmund University as a tool to test a student project.
As far as we are concerned, we used the application to learn applications like Bugzilla and parts of the famous Wordpress.

**Could I potentially learn any available application that is accessible over the internet?** <br>
Yes, you could, but really should not do that, since testing usually takes a lot of traffic, and your test targets may not like it.
But we do not programmatically prohibit it either.
The primary use case is to use ALEX for testing applications that are installed locally or in the same network.

**Do I really not have to have any programming experience?** <br>
Yes and no, it depends on how you define programming experience.
We made the best efforts to abstract all necessary steps to test a web application with ease.
While modelling Selenium tests, it may eventually be helpful to have basic understanding of HTML and CSS.
The same goes for modelling REST tests where it is needed that you can write JSON documents.
But to our understanding neither JSON, HTML nor CSS are programming languages.

**How potent does my system have to be to run tests?** <br>
Learning is a CPU and memory intense process, but we cannot really tell you an lower bound for your system specs.
From our own observations, it is advised to have at least 2Gb of RAM and a relatively modern Dual Core CPU to run tests at a satisfiable performance.
The more power your system has, the faster your tests should execute.
But feel free to test it on your Raspberry PI.

**I want to learn a specific feature of my application but ALEX does not provide a way to model it. What can I do?** <br>
Initially, we did not develop ALEX as a solution to all situations that may occur in a web application, but to the most common ones.
If you think a key feature is missing, feel free to submit an issue and we will see what we can do.

*Note: Surprisingly, neither of the above questions have been asked at any point in time. But it it still a neat way to package information that do not fit anywhere else in the documentation.*

[java]: https://java.com
[maven]: https://maven.apache.org
[nodejs]: https://nodejs.org
[grunt]: http://gruntjs.com
[bower]: http://bower.io
Loading

0 comments on commit d4f6965

Please sign in to comment.