├── .gitignore ├── LICENSE ├── README.md ├── build.sbt ├── project ├── build.properties └── plugins.sbt ├── src ├── main │ └── scala │ │ └── com │ │ └── github │ │ └── jarlakxen │ │ └── reactive │ │ └── serial │ │ ├── Port.scala │ │ ├── ReactiveSerial.scala │ │ ├── SerialActorPublisher.scala │ │ └── SerialActorSubscriber.scala └── test │ ├── resources │ ├── logback-test.xml │ └── reference.conf │ └── scala │ └── com │ └── github │ └── jarlakxen │ └── reactive │ └── serial │ ├── ReactiveSerialSpec.scala │ └── package.scala └── version.sbt /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | *.log 3 | 4 | # sbt specific 5 | .cache 6 | .cache-main 7 | .cache-tests 8 | .history 9 | .lib/ 10 | dist/* 11 | target/ 12 | lib_managed/ 13 | src_managed/ 14 | project/boot/ 15 | project/plugins/project/ 16 | 17 | # Scala-IDE specific 18 | .scala_dependencies 19 | .worksheet 20 | 21 | # Eclipse conf file 22 | .settings 23 | .classpath 24 | .project 25 | .manager 26 | 27 | # Idea 28 | .idea 29 | *.iml 30 | 31 | /bin/ 32 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Reactive Streams for Serial Communication 2 | 3 | [Reactive Streams](http://www.reactive-streams.org) wrapper for [jSerialComm](http://fazecast.github.io/jSerialComm/). 4 | 5 | Available for 2.11 and 2.12: 6 | 7 | ````scala 8 | resolvers += Resolver.bintrayRepo("jarlakxen", "maven") 9 | libraryDependencies += "com.github.jarlakxen" %% "reactive-serial" % "1.4" 10 | ```` 11 | 12 | Example usage 13 | ---- 14 | 15 | ```Scala 16 | import akka.actor.ActorSystem 17 | import akka.stream.ActorMaterializer 18 | import akka.stream.scaladsl.{Sink, Source} 19 | import com.github.jarlakxen.reactive.serial.ReactiveSerial 20 | 21 | implicit val actorSystem = ActorSystem("ReactiveSerial") 22 | implicit val materializer = ActorMaterializer() 23 | 24 | val serialPort = ReactiveSerial.port("/dev/ttyUSB0") 25 | 26 | val serial = ReactiveSerial(port = serialPort, baudRate = 57600) 27 | 28 | val publisher: Publisher[ByteString] = serial.publisher(bufferSize=100) 29 | val subscriber: Subscriber[ByteString] = serial.subscriber(requestStrategyProvider=ZeroRequestStrategy) 30 | 31 | Source.fromPublisher(publisher).map(_.message().toUpperCase).to(Sink.fromSubscriber(subscriber)).run() 32 | ``` 33 | -------------------------------------------------------------------------------- /build.sbt: -------------------------------------------------------------------------------- 1 | import sbt.Keys._ 2 | 3 | // ··· Settings ··· 4 | 5 | 6 | // ··· Project Info ··· 7 | 8 | name := "reactive-serial" 9 | 10 | organization := "com.github.jarlakxen" 11 | 12 | crossScalaVersions := Seq("2.11.8", "2.12.1") 13 | 14 | scalaVersion <<= (crossScalaVersions) { versions => versions.head } 15 | 16 | fork in run := true 17 | 18 | publishArtifact in Test := false 19 | 20 | licenses += ("Apache-2.0", url("https://opensource.org/licenses/Apache-2.0")) 21 | 22 | // ··· Project Enviroment ··· 23 | 24 | 25 | // ··· Project Options ··· 26 | 27 | scalacOptions ++= Seq( 28 | "-encoding", 29 | "utf8", 30 | "-feature", 31 | "-language:postfixOps", 32 | "-language:implicitConversions", 33 | "-language:higherKinds", 34 | "-unchecked", 35 | "-deprecation" 36 | ) 37 | 38 | scalacOptions in Test ++= Seq("-Yrangepos") 39 | 40 | // ··· Project Dependancies ··· 41 | 42 | val vAkka = "2.4.14" 43 | val vjSerialComm = "1.3.11" 44 | val vSlf4J = "1.7.22" 45 | val vLogback = "1.1.8" 46 | val vSpec2 = "3.8.6" 47 | val vJUnit = "4.12" 48 | 49 | libraryDependencies ++= Seq( 50 | // --- Akka -- 51 | "com.typesafe.akka" %% "akka-actor" % vAkka % "provided", 52 | "com.typesafe.akka" %% "akka-stream" % vAkka % "provided", 53 | // --- Akka -- 54 | "com.fazecast" % "jSerialComm" % vjSerialComm, 55 | // --- Logger --- 56 | "org.slf4j" % "slf4j-api" % vSlf4J, 57 | "ch.qos.logback" % "logback-classic" % vLogback % "test", 58 | // --- Testing --- 59 | "com.typesafe.akka" %% "akka-slf4j" % vAkka % "test", 60 | "com.typesafe.akka" %% "akka-stream-testkit" % vAkka % "test", 61 | "org.specs2" %% "specs2-core" % vSpec2 % "test", 62 | "org.specs2" %% "specs2-mock" % vSpec2 % "test", 63 | "org.specs2" %% "specs2-junit" % vSpec2 % "test", 64 | "junit" % "junit" % vJUnit % "test" 65 | ) 66 | 67 | pomExtra := ( 68 | https://github.com/Jarlakxen/reactive-serial 69 | 70 | 71 | Apache License v2 72 | https://github.com/Jarlakxen/reactive-serial/blob/master/LICENSE 73 | repo 74 | 75 | 76 | 77 | https://github.com/Jarlakxen/reactive-serial 78 | scm:git:git@github.com:Jarlakxen/reactive-serial.git 79 | scm:git:git@github.com:Jarlakxen/reactive-serial.git 80 | 81 | 82 | 83 | Jarlakxen 84 | Facundo Viale 85 | https://github.com/Jarlakxen/reactive-serial 86 | 87 | 88 | ) 89 | -------------------------------------------------------------------------------- /project/build.properties: -------------------------------------------------------------------------------- 1 | sbt.version=0.13.12 2 | -------------------------------------------------------------------------------- /project/plugins.sbt: -------------------------------------------------------------------------------- 1 | 2 | addSbtPlugin("com.github.gseitz" % "sbt-release" % "1.0.3") 3 | 4 | addSbtPlugin("com.eed3si9n" % "sbt-unidoc" % "0.2.0") -------------------------------------------------------------------------------- /src/main/scala/com/github/jarlakxen/reactive/serial/Port.scala: -------------------------------------------------------------------------------- 1 | package com.github.jarlakxen.reactive.serial 2 | 3 | import com.fazecast.jSerialComm.SerialPort 4 | import scala.util.{ Try, Failure, Success } 5 | import akka.util.ByteString 6 | import java.io.IOException 7 | 8 | /** 9 | * @author fviale 10 | */ 11 | class Port(port: SerialPort) { 12 | 13 | def systemName = port.getSystemPortName 14 | 15 | def open(baudRate: Int): Try[_] = { 16 | if (isClose) { 17 | port.setBaudRate(baudRate) 18 | port.setComPortTimeouts(SerialPort.TIMEOUT_READ_SEMI_BLOCKING | SerialPort.TIMEOUT_WRITE_BLOCKING, 0, 0) 19 | if (port.openPort) 20 | Success(()) 21 | else 22 | Failure(new IOException(s"Cannot open port '${port.getSystemPortName}'")) 23 | } else { 24 | Success(()) 25 | } 26 | } 27 | 28 | def isOpen = port.isOpen 29 | def isClose = !isOpen 30 | 31 | def read(buffer: Array[Byte]): Try[Int] = { 32 | val bytes = port.readBytes(buffer, buffer.length) 33 | if (bytes == -1) { 34 | Failure(new IOException(s"There was an error reading the port '${port.getSystemPortName}'")) 35 | } else { 36 | Success(bytes) 37 | } 38 | } 39 | 40 | def write(data: ByteString): Try[Int] = { 41 | val bytes = port.writeBytes(data.toArray, data.length) 42 | if (bytes == -1) { 43 | Failure(new IOException(s"There was an error writing to the port '${port.getSystemPortName}'")) 44 | } else { 45 | Success(bytes) 46 | } 47 | } 48 | 49 | def close: Try[_] = { 50 | if (port.closePort()) 51 | Success(()) 52 | else 53 | Failure(new IOException(s"Cannot open port '${port.getSystemPortName}'")) 54 | } 55 | 56 | } -------------------------------------------------------------------------------- /src/main/scala/com/github/jarlakxen/reactive/serial/ReactiveSerial.scala: -------------------------------------------------------------------------------- 1 | package com.github.jarlakxen.reactive.serial 2 | 3 | import scala.collection.JavaConversions._ 4 | import scala.collection.JavaConverters._ 5 | import akka.actor._ 6 | import akka.stream.actor.{ RequestStrategy, ActorPublisher, ActorSubscriber } 7 | import akka.util.ByteString 8 | import com.fazecast.jSerialComm.SerialPort 9 | import org.reactivestreams.{ Publisher, Subscriber } 10 | 11 | /** 12 | * @author fviale 13 | */ 14 | 15 | case class ReactiveSerial(port: Port, baudRate: Int = 9600) { 16 | 17 | def publisher(bufferSize: Int)(implicit actorSystem: ActorSystem): Publisher[ByteString] = 18 | ActorPublisher[ByteString](actorPublisher(bufferSize)) 19 | 20 | def actorPublisher(bufferSize: Int)(implicit actorSystem: ActorSystem): ActorRef = 21 | actorSystem.actorOf(actorPublisherProps(bufferSize)) 22 | 23 | def actorPublisherProps(bufferSize: Int): Props = 24 | Props(new SerialActorPublisher(port, baudRate, bufferSize)) 25 | 26 | def subscriber(requestStrategyProvider: RequestStrategy)(implicit actorSystem: ActorSystem): Subscriber[ByteString] = 27 | ActorSubscriber[ByteString](actorSubscriber(requestStrategyProvider)) 28 | 29 | def actorSubscriber(requestStrategyProvider: RequestStrategy)(implicit actorSystem: ActorSystem): ActorRef = 30 | actorSystem.actorOf(actorSubscriberProps(requestStrategyProvider)) 31 | 32 | def actorSubscriberProps(requestStrategyProvider: RequestStrategy): Props = 33 | Props(new SerialActorSubscriber(port, baudRate, requestStrategyProvider)) 34 | 35 | } 36 | 37 | object ReactiveSerial { 38 | 39 | lazy val ports = SerialPort.getCommPorts.map(new Port(_)).toList 40 | 41 | def port(descriptor: String) = new Port(SerialPort.getCommPort(descriptor)) 42 | 43 | def apply(): ReactiveSerial = { 44 | if (ports.nonEmpty) { 45 | ReactiveSerial(ports.head) 46 | } else { 47 | throw new RuntimeException("No available ports") 48 | } 49 | } 50 | 51 | def apply(descriptor: String): ReactiveSerial = ReactiveSerial(port(descriptor)) 52 | 53 | } -------------------------------------------------------------------------------- /src/main/scala/com/github/jarlakxen/reactive/serial/SerialActorPublisher.scala: -------------------------------------------------------------------------------- 1 | package com.github.jarlakxen.reactive.serial 2 | 3 | import akka.actor.{ PoisonPill, ActorLogging } 4 | import akka.stream.actor.{ ActorPublisher, ActorPublisherMessage } 5 | import akka.util.ByteString 6 | import scala.annotation.tailrec 7 | import scala.util.{ Try, Success, Failure } 8 | import java.nio.ByteBuffer 9 | 10 | /** 11 | * @author fviale 12 | */ 13 | 14 | private[serial] class SerialActorPublisher( 15 | port: Port, 16 | baudRate: Int, 17 | bufferSize: Int) extends ActorPublisher[ByteString] with ActorLogging { 18 | 19 | val readBuffer = new Array[Byte](bufferSize) 20 | 21 | override def preStart(): Unit = { 22 | port.open(baudRate).recover { 23 | case ex => 24 | log.error(ex, "Cannot start stream") 25 | port.close 26 | onErrorThenStop(ex) 27 | } 28 | } 29 | 30 | override def receive = { 31 | case ActorPublisherMessage.Request(requestedElements) => 32 | log.debug(s"Requesting $requestedElements elements") 33 | readDemandedItems(requestedElements) 34 | case ActorPublisherMessage.Cancel | ActorPublisherMessage.SubscriptionTimeoutExceeded => 35 | log.debug("Canceling streaming") 36 | port.close 37 | onCompleteThenStop() 38 | } 39 | 40 | private def tryReadingSingleElement(): Try[ByteString] = 41 | port.read(readBuffer).map(length => ByteString.fromArray(readBuffer, 0, length)) 42 | 43 | @tailrec 44 | private def readDemandedItems(requestedElements: Long): Unit = { 45 | tryReadingSingleElement() match { 46 | case Success(data) if requestedElements > 0 => 47 | onNext(data) 48 | readDemandedItems(requestedElements - 1) 49 | case Failure(ex) => 50 | onErrorThenStop(ex) 51 | case _ => // Do Nothing 52 | } 53 | } 54 | } -------------------------------------------------------------------------------- /src/main/scala/com/github/jarlakxen/reactive/serial/SerialActorSubscriber.scala: -------------------------------------------------------------------------------- 1 | package com.github.jarlakxen.reactive.serial 2 | 3 | import akka.actor.{ PoisonPill, ActorLogging } 4 | import akka.stream.actor.{ ActorSubscriber, ActorSubscriberMessage, RequestStrategy } 5 | import akka.util.ByteString 6 | import scala.util.{ Try, Success, Failure } 7 | 8 | /** 9 | * @author fviale 10 | */ 11 | 12 | private[serial] class SerialActorSubscriber( 13 | port: Port, 14 | baudRate: Int, 15 | requestStrategyProvider: RequestStrategy) 16 | extends ActorSubscriber with ActorLogging { 17 | 18 | override protected val requestStrategy = requestStrategyProvider 19 | 20 | override def preStart(): Unit = { 21 | port.open(baudRate) match { 22 | case Success(_) => 23 | request(1) 24 | case Failure(ex) => 25 | log.error(ex, "Cannot start stream") 26 | cancel() 27 | } 28 | } 29 | 30 | def receive = { 31 | case ActorSubscriberMessage.OnNext(data: ByteString) => 32 | process(data) 33 | 34 | case ActorSubscriberMessage.OnError(ex) => 35 | handleError(ex) 36 | 37 | case ActorSubscriberMessage.OnComplete => 38 | stop() 39 | 40 | } 41 | 42 | private def process(data: ByteString): Unit = { 43 | port.write(data) match { 44 | case Success(_) => 45 | request(1) 46 | case Failure(ex) => 47 | log.error(ex, "Cannot continue with stream") 48 | cancel() 49 | } 50 | } 51 | 52 | private def handleError(ex: Throwable): Unit = { 53 | log.error("Stopping serial communication due to fatal error.", ex) 54 | stop() 55 | } 56 | 57 | private def stop(): Unit = { 58 | port.close 59 | context.stop(self) 60 | } 61 | 62 | } -------------------------------------------------------------------------------- /src/test/resources/logback-test.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | %d{HH:mm:ss.SSS} %-5level %logger{36} - %msg%n%rEx 5 | 6 | 7 | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /src/test/resources/reference.conf: -------------------------------------------------------------------------------- 1 | akka { 2 | loggers = ["akka.event.slf4j.Slf4jLogger"] 3 | loglevel = "DEBUG" 4 | } -------------------------------------------------------------------------------- /src/test/scala/com/github/jarlakxen/reactive/serial/ReactiveSerialSpec.scala: -------------------------------------------------------------------------------- 1 | package com.github.jarlakxen.reactive.serial 2 | 3 | import scala.concurrent.ExecutionContext._ 4 | import scala.concurrent.duration._ 5 | import scala.util.{ Try, Failure, Success } 6 | import org.junit.runner.RunWith 7 | import org.specs2.mutable._ 8 | import org.specs2.mock.Mockito 9 | import org.specs2.specification.core._ 10 | import org.specs2.specification.mutable._ 11 | import org.specs2.runner.JUnitRunner 12 | import akka.stream._ 13 | import akka.stream.actor.ZeroRequestStrategy 14 | import akka.stream.scaladsl._ 15 | import akka.stream.testkit.scaladsl._ 16 | import akka.stream.actor.ActorPublisherMessage.Request 17 | import akka.testkit._ 18 | import akka.util.ByteString 19 | import org.mockito.Matchers._ 20 | 21 | /** 22 | * @author fviale 23 | */ 24 | 25 | @RunWith(classOf[JUnitRunner]) 26 | class ReactiveSerialSpec extends Specification with Mockito with Environment { 27 | sequential 28 | 29 | def afterThan(duration: Duration) = after(duration) 30 | 31 | def is(env: Env) = { 32 | 33 | "ReactiveSerial specification" >> { 34 | 35 | "test a stream using the actorPublisher" in new AkkaContext { 36 | 37 | implicit val materializer = ActorMaterializer() 38 | 39 | val msg1 = ByteString(1, 2, 3) 40 | val msg2 = ByteString(4, 5, 6) 41 | 42 | val port = spy(new Port(null)) 43 | 44 | doReturn(Success(())).when(port).open(anyInt) 45 | doReturn(Success(())).when(port).close 46 | 47 | val streamProbe = Source.actorPublisher(ReactiveSerial(port).actorPublisherProps(100)).runWith(TestSink.probe[ByteString]) 48 | 49 | doAnswer { buffer => msg1.copyToArray(buffer.asInstanceOf[Array[Byte]]); Success(msg1.length) }.when(port).read(any[Array[Byte]]) 50 | streamProbe.request(1).expectNext(msg1) 51 | doAnswer { buffer => msg2.copyToArray(buffer.asInstanceOf[Array[Byte]]); Success(msg2.length) }.when(port).read(any[Array[Byte]]) 52 | streamProbe.request(1).expectNext(msg2) 53 | 54 | streamProbe.cancel() 55 | 56 | there was one(port).close 57 | } 58 | 59 | "test a stream using the actorSubscriber" in new AkkaContext { 60 | 61 | implicit val materializer = ActorMaterializer() 62 | 63 | val msg1 = ByteString(1, 2, 3) 64 | val msg2 = ByteString(4, 5, 6) 65 | 66 | val port = mock[Port] 67 | 68 | doReturn(Success(())).when(port).open(anyInt) 69 | doReturn(Success(())).when(port).close 70 | 71 | port.write(any[ByteString]) returns Success(3) 72 | 73 | val (pub, sub) = TestSource.probe[ByteString] 74 | .toMat(Sink.actorSubscriber[ByteString](ReactiveSerial(port).actorSubscriberProps(ZeroRequestStrategy)))(Keep.both) 75 | .run() 76 | 77 | pub.sendNext(msg1) 78 | pub.sendNext(msg2) 79 | 80 | there was afterThan(10.millis).one(port).write(msg1) andThen afterThan(10.millis).one(port).write(msg2) 81 | } 82 | } 83 | } 84 | 85 | } -------------------------------------------------------------------------------- /src/test/scala/com/github/jarlakxen/reactive/serial/package.scala: -------------------------------------------------------------------------------- 1 | package com.github.jarlakxen.reactive 2 | 3 | import akka.actor._ 4 | import akka.testkit._ 5 | import org.specs2.specification.After 6 | 7 | /** 8 | * @author fviale 9 | */ 10 | 11 | package object serial { 12 | 13 | abstract class AkkaContext extends TestKit(ActorSystem("Test")) 14 | with After 15 | with ImplicitSender { 16 | 17 | def after = { 18 | system.shutdown 19 | system.awaitTermination 20 | } 21 | } 22 | 23 | } -------------------------------------------------------------------------------- /version.sbt: -------------------------------------------------------------------------------- 1 | version in ThisBuild := "1.4" 2 | --------------------------------------------------------------------------------