Skip to content
Permalink
Browse files
Update instamo archetype for 2.0.0
* Drop Travis in favor of GitHub Actions for CI
* Simplify example project built from the archetype
  • Loading branch information
ctubbsii committed Aug 11, 2020
1 parent 8ec26b9 commit 322e8ac0461db74260e60f1e703cbbed7948f3ad
Show file tree
Hide file tree
Showing 15 changed files with 275 additions and 601 deletions.
@@ -0,0 +1,76 @@
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF 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
#
# 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.
#

# This workflow will build a Java project with Maven
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven

name: QA

on:
push:
branches: [ '*' ]
pull_request:
branches: [ '*' ]

jobs:
mvn:
strategy:
matrix:
profile:
- {name: 'verify', args: 'verify'}
fail-fast: false
timeout-minutes: 60
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up JDK 11
uses: actions/setup-java@v1
with:
java-version: 11
- name: Cache local maven repository
uses: actions/cache@v2
with:
path: |
~/.m2/repository/
!~/.m2/repository/org/apache/accumulo
key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
restore-keys: ${{ runner.os }}-m2
- name: Build with Maven (${{ matrix.profile.name }})
run: mvn -B -V -e -ntp "-Dstyle.color=always" ${{ matrix.profile.args }}
env:
MAVEN_OPTS: -Djansi.force=true
- name: Upload unit test results
uses: actions/upload-artifact@v2
with:
name: surefire-reports-${{ matrix.profile.name }}
path: ./**/target/surefire-reports/
if-no-files-found: ignore
- name: Upload integration test results
uses: actions/upload-artifact@v2
with:
name: failsafe-reports-${{ matrix.profile.name }}
path: ./**/target/failsafe-reports/
if-no-files-found: ignore
- name: Upload mini test logs
uses: actions/upload-artifact@v2
with:
name: mini-tests-logs-${{ matrix.profile.name }}
path: ./**/target/**/mini-tests/**/logs/
if-no-files-found: ignore

This file was deleted.

@@ -15,24 +15,26 @@
limitations under the License.
-->

Instamo Archetype
=======
# Instamo Archetype

## About

About
-----------
This is a Maven Archetype which automates the customization of Instamo, a small
amount of code meant to quickly spin up Accumulo processes in memory in an
attempt to get out of the way of the developer who wants to run code against
Accumulo.

Usage
-----------
## Usage

Checkout this project and run a `mvn install`. This will install the archetype
to your local repository.

Then, change to a new directory and run

`mvn archetype:generate -DarchetypeGroupId=org.apache.accumulo -DarchetypeArtifactId=instamo-archetype -DinteractiveMode=false`
```bash
mvn archetype:generate -DarchetypeGroupId=org.apache.accumulo -DarchetypeArtifactId=accumulo2-instamo-archetype -DinteractiveMode=false
```

and Maven will prompt you to enter the rest of the necessary configuration
parameters (e.g. groupId, artifactId, version and Java package)

27 pom.xml
@@ -15,19 +15,20 @@
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">
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.apache</groupId>
<artifactId>apache</artifactId>
<version>18</version>
<version>23</version>
</parent>

<groupId>org.apache.accumulo</groupId>
<artifactId>accumulo-instamo-archetype</artifactId>
<version>1.6.0-SNAPSHOT</version>
<artifactId>accumulo2-instamo-archetype</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>maven-archetype</packaging>
<name>Accumulo Instamo Archetype</name>
<description>Instant Accumulo Client Project</description>
<scm>
<connection>scm:git:https://gitbox.apache.org/repos/asf/accumulo-instamo-archetype.git</connection>
<developerConnection>scm:git:https://gitbox.apache.org/repos/asf/accumulo-instamo-archetype.git</developerConnection>
@@ -43,15 +44,15 @@
<extension>
<groupId>org.apache.maven.archetype</groupId>
<artifactId>archetype-packaging</artifactId>
<version>3.0.1</version>
<version>3.2.0</version>
</extension>
</extensions>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-archetype-plugin</artifactId>
<version>3.0.1</version>
<version>3.2.0</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -63,19 +64,5 @@
</plugin>
</plugins>
</pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.rat</groupId>
<artifactId>apache-rat-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>check</goal>
</goals>
<phase>verify</phase>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
@@ -41,18 +41,18 @@
<include>**/*.java</include>
</includes>
</fileSet>
<fileSet filtered="true" encoding="UTF-8">
<directory>src/main/resources</directory>
<includes>
<include>**/*.properties</include>
</includes>
</fileSet>
<fileSet filtered="true" packaged="true" encoding="UTF-8">
<directory>src/test/java</directory>
<includes>
<include>**/*.java</include>
</includes>
</fileSet>
<fileSet filtered="true" encoding="UTF-8">
<directory>src/test/resources</directory>
<includes>
<include>**/*.properties</include>
</includes>
</fileSet>
<fileSet filtered="true" encoding="UTF-8">
<directory></directory>
<includes>
@@ -15,43 +15,15 @@
limitations under the License.
-->

Instamo
=======
# Instamo

Introduction
-----------
Instamo is a skeleton project that serves as an example client application for
[Apache Accumulo](https://accumulo.apache.org) to help you get started.

Instamo makes it easy to write some code and run it against a local, transient
[Accumulo](http://accumulo.apache.org) instance in minutes. No setup or
installation is required. This is possible if Java and Maven are already
installed by following the steps below.
Build the application and run its provided example integration tests by
executing the following:

```bash
mvn verify
```
vim src/test/java/${package}/ExampleAccumuloUnitTest.java
mvn package
```

The maven package command will run the unit test. After packing the code, you
can also run one of the below applications.

Map Reduce
----------

It's possible to run local map reduce jobs against the MiniAccumuloCluster
instance. There is an example of this in the src directory The following
command will run the map reduce example.

```
mvn exec:exec -P mapreduce
```

Accumulo Shell
-----------

The Accumulo shell is a simple application that, among other features, provides
interactive access to tables in Accumulo. The following command will launch the
shell against a local Accumulo instance.

```
mvn exec:exec -P shell
```

0 comments on commit 322e8ac

Please sign in to comment.