This guide will help you understand how to create plans with Bamboo Java Specs. You'll create a simple project and execute it to create a plan in Bamboo.

はじめる前に

Make sure you have the following installed:

• JDK 8 or higher
• Maven 3.2 or higher
• Eclipse or IntelliJ IDEA IDE

Note: You may use a different IDE, but tutorial provides examples for the two above

• Bamboo 6.0 or higher

Step 1: Create a project base with Maven

To create a base of the project, execute the following Maven archetype:

mvn archetype:generate -B \
    -DarchetypeGroupId=com.atlassian.bamboo -DarchetypeArtifactId=bamboo-specs-archetype \
	-DarchetypeVersion=6.2.1 \
    -DgroupId=com.atlassian.bamboo -DartifactId=bamboo-specs -Dversion=1.0.0-SNAPSHOT \
    -Dpackage=tutorial -Dtemplate=minimal

ここで:

The project is created in the bamboo-specs directory:

cd bamboo-specs

Step 2: Import the project into IDE

You can now import the project into your integrated development environment (IDE).

If you want to see how PlanSpec.java files is structured, go to src/main/java/tutorial/PlanSpec.java. Your file should have the following structure:

Step 3: Define a job with a script task

1. In the createPlan method put a cursor after the description method call:

   private Plan createPlan() {
       return new Plan(
               project(),
               "Plan Name", "PLANKEY")
               .description("Plan created from (enter repository url of your plan)");
   }

2. Type "." and let your IDE show you available options:
3. Select the stages method and add the new Stage ("Stage 1") constructor call inside the method's argument (you need to add the import statement for Stage class).

4. Add a job to the stage using the jobs method and new J o b() constructor (add the import statement too). Name the job Build & run and use RUN for a key:

   private Plan createPlan() {
       return new Plan(
               project(),
               "Plan Name", "PLANKEY")
               .description("Plan created from (enter repository url of your plan)")
               .stages(
                       new Stage("Stage 1")
                               .jobs(new Job("Build & run", "RUN")));
   }

5. Let's add a task to the job. Type .tasks() and declare a new ScriptTask() inside as shown below (add the import statement too). Call .inlineBody on the ScriptTask().

   private Plan createPlan() {
       return new Plan(
               project(),
               "Plan Name", "PLANKEY")
               .description("Plan created from (enter repository url of your plan)")
               .stages(
                       new Stage("Stage 1")
                               .jobs(new Job("Build & run", "RUN")
                                       .tasks(
                                               new ScriptTask().inlineBody("echo Hello world!"))));
   }

Step 4: Validate Bamboo Specs offline

You can perform offline validation before deploying a plan to Bamboo. Let's try it out by running a unit test.

mvn test

Test fails with the following stack trace:

com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException: 
Plan or job / Name: can not contain any of those characters: [", &, ', <, >, \] but it is 'Build & run'
    at com.atlassian.bamboo.specs.api.validators.common.ImporterUtils.checkNoErrors(ImporterUtils.java:44)
    ...
    at tutorial.PlanSpec.createPlan(PlanSpec.java:42)
    at tutorial.PlanSpecTest.checkYourPlanOffline(PlanSpecTest.java:12)	

ここで:

As you can see, the validation fails because the name of the job contains an invalid & character. Let's remove it. Your code should look like this now:

private Plan createPlan() {
    return new Plan(
            project(),
            "Plan Name", "PLANKEY")
            .description("Plan created from (enter repository url of your plan)")
            .stages(
                    new Stage("Stage 1")
                            .jobs(new Job("Run", "RUN")
                                    .tasks(
                                            new ScriptTask().inlineBody("echo Hello world!"))));
}

Run the test again to make sure that it passes this time.

Step 5: Publish Bamboo Specs to the Bamboo server

When you're sending a plan, Bamboo validates it. 

mvn -Ppublish-specs

The console output looks like this:

Publishing plan PLANKEY
Result OK: http://localhost:8085/browse/PRJ-PLANKEY

Step 6: Check the results

1. Go to your Bamboo instance.
2. Open the plan that you created.
3. Go to Actions > Configure plan.
4. Check whether the stage contains a job with the Hello world Script task.
5. Select Run > Run plan to execute the build.
6. Find the "Hello World!" message in the logs.  

次のステップ

 Here are some resources that can help you with writing your own Bamboo Specs:

• Create a Bamboo Specs project using Maven Archetype
• Exporting existing plan configurations to Bamboo Specs
• Creating deployment projects in Bamboo Specs
• Bamboo Specs reference
• Bamboo Specs API reference