gwen.web.GwenWebInterpreter.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwen-web Show documentation
Web automation engine for Gwen
There is a newer version: 4.1.1
/*
 * Copyright 2021 Branko Juric, Brady Wood
 * 
 * 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.
 */

package gwen.web

import gwen.web.eval.WebEngine

import gwen.GwenInterpreter
import gwen.core._

import java.io.File

import scala.io.Source
import scala.util.chaining._

/**
  * The main gwen-web interpreter.
  */
object GwenWebInterpreter extends GwenInterpreter(new WebEngine()) {

  /**
    * Initialises a Gwen project directory.
    *
    * @param dir the directory to initialise
    */
  override def initProject(dir: File): Unit = {
    
    super.initProject(dir)

    new File(dir, "browsers") tap { dir =>
      FileIO.copyClasspathTextResourceToFile("/init/browsers/chrome.conf", dir)
      FileIO.copyClasspathTextResourceToFile("/init/browsers/edge.conf", dir)
      FileIO.copyClasspathTextResourceToFile("/init/browsers/firefox.conf", dir)
      FileIO.copyClasspathTextResourceToFile("/init/browsers/ie.conf", dir)
      FileIO.copyClasspathTextResourceToFile("/init/browsers/safari.conf", dir)
      FileIO.copyClasspathTextResourceToFile("/init/browsers/remote.conf", dir)
      FileIO.copyClasspathTextResourceToFile("/init/browsers/README.md", dir)
    }

    new File(dir, "env") tap { dir =>
      FileIO.copyClasspathTextResourceToFile("/init/env/local.conf", dir)
      FileIO.copyClasspathTextResourceToFile("/init/env/dev.conf", dir)
      FileIO.copyClasspathTextResourceToFile("/init/env/test.conf", dir)
      FileIO.copyClasspathTextResourceToFile("/init/env/README.md", dir)
    }

    new File(dir, "features") tap { dir =>
      FileIO.copyClasspathTextResourceToFile("/init/features/README.md", dir)
    }

    new File(dir, "meta") tap { dir =>
      FileIO.copyClasspathTextResourceToFile("/init/meta/README.md", dir)
    }

    new File(dir, "samples/floodio") tap { dir =>
      FileIO.copyClasspathTextResourceToFile("/init/samples/floodio/FloodIO.feature", dir)
      FileIO.copyClasspathTextResourceToFile("/init/samples/floodio/FloodIO.meta", dir)
    }

    new File(dir, "samples/google") tap { dir =>
      FileIO.copyClasspathTextResourceToFile("/init/samples/google/Google.feature", dir)
      FileIO.copyClasspathTextResourceToFile("/init/samples/google/Google.meta", dir)
    }

    new File(dir, "samples/todo") tap { dir =>
      FileIO.copyClasspathTextResourceToFile("/init/samples/todo/Todo.feature", dir)
      FileIO.copyClasspathTextResourceToFile("/init/samples/todo/Todo.meta", dir)
    }

    FileIO.copyClasspathTextResourceToFile("/init/README.md", dir)
    FileIO.copyClasspathTextResourceToFile("/init/gitignore", dir, Some(".gitignore"))
    if (!new File("gwen.conf").exists()) {
      val res = Source.fromInputStream(getClass.getResourceAsStream("/init/gwen.conf"))
      val conf = try res.mkString.replace("${gwen.initDir}", dir.getPath) finally res.close()
      new File("gwen.conf").writeText(conf)
    }

    val standalone = dir.isSame(new File("."))
    val filler = if (standalone) "   " else "       "

    println(
      s"""|  ./            $filler        # Project root
          |   ├── gwen.conf$filler        # Project settings${if (standalone) "" else {
      s"""|
          |   └── /${dir.getPath}""".stripMargin}}
          |$filler├── .gitignore          # Git ignore file
          |$filler├── README.md
          |$filler├── /browsers           # Browser settings
          |$filler│   ├── chrome.conf
          |$filler│   ├── edge.conf
          |$filler│   ├── firefox.conf
          |$filler│   ├── safari.conf
          |$filler│   ├── ie.conf
          |$filler│   ├── remote.conf     # Remote web driver settings
          |$filler│   └── README.md
          |$filler├── /env                # Environment settings
          |$filler│   ├── local.conf
          |$filler│   ├── dev.conf
          |$filler│   ├── test.conf
          |$filler│   └── README.md
          |$filler├── /features           # Features and associative meta
          |$filler│   └── README.md
          |$filler├── /meta               # Optional common/reusable meta
          |$filler│   └── README.md
          |$filler└── /samples            # Sample features and meta
          |
          |""".stripMargin
    )

  }

}