android_reporter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d590d50a4dbcbeba7083df8c3f97960b1b140cc91a59d35b8843db3149a6eb76
+  data.tar.gz: f8f07f0f05784f63bcac6509211ec329b7abca3b662cd7eda4f987cee098750c
+SHA512:
+  metadata.gz: 47985438872752c72374a1cb09e70e9e049f75e0ca3cbf987aaed297b817a6393f78440315ed997579aa8b22aef339cbfdf7b1fae70a02d4555cacaa6bb82828
+  data.tar.gz: 47c9f41b02b9bbcd465bc46e02ae62d40c4cb66bd2340f658f487024748f3ac182e1a9035302f6b71c2ec09964b3bb8dfa6885fe3110a99984f514865a69168e

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Yazan Tarifi <yazan.tarifi@opensooq.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# android_reporter plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/android_reporter)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `android_reporter`, add it to your project by running:
+
+```bash
+fastlane add_plugin android_reporter
+```
+
+## About android_reporter
+
+Open Android Emeulators Then Generate Report File From Tests then Upload the File To Slack
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/android_reporter.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/android_reporter/version'
+
+module Fastlane
+  module AndroidReporter
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::AndroidReporter.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/android_reporter/actions/android_reporter_action.rb

@@ -0,0 +1,330 @@
+require 'fastlane/action'
+require_relative '../helper/android_reporter_helper'
+require 'open3'
+require 'date'
+require 'rubygems'
+require 'slack-ruby-client'
+
+module Fastlane
+  module Actions
+    class AndroidReporterAction < Action
+      def self.run(params)
+        UI.message("The Android Reporter Plugin Working !!")
+
+        # Create Variables
+        avd_name = params[:avd_name]
+        android_sdk_path = params[:android_sdk_path]
+        generate_adb_file = params[:generate_adb_file]
+        generate_gradle_files = params[:generate_gradle_files]
+        gradle_task_testing_name = params[:gradle_task_testing_name]
+        is_slack_enabled = params[:is_slack_upload_reports_enabled]
+        slack_api_key = params[:slack_api_key]
+        time = Time.now.to_s
+        time = DateTime.parse(time).strftime("%d/%m/%Y %H:%M")
+        isLogcatFileUploaded = false
+        isGradleDebugFileUploaded = false
+        isGradleErrorFileUploaded = false
+
+        # 0. Checkout git to Current Branch to Run Tests on the Current Branch
+        if params[:tests_branch_name].to_s.length > 0
+            begin
+                sh("git fetch")
+                sh("git checkout ", params[:tests_branch_name].string)
+            rescue => error
+                UI.error("Something Error with Git Commands")
+            end
+        end
+
+        # 1. Send Slack Message from Android Reporter Bot That Testing Task Has been Started ....
+        if is_slack_enabled
+            UI.message("Slack Messages Bot Started .... [Configuration Step]")
+            Slack.configure do |config|
+               config.token = slack_api_key
+            end
+               client = Slack::Web::Client.new
+               begin
+                  client.chat_postMessage(
+                        channel: "#" + params[:slack_channel_name],
+                        text:   " ================================================================================== \n" +
+                                " New UI Testing Task Started For Current Release : " + time + " \n " +
+                                " Current Branch Build : " + sh("git branch") +
+                                " ================================================================================== \n",
+                        as_user: true
+                  )
+
+                  UI.message("Slack Build Task Message Result : [Send First Task Message] ")
+               rescue => error
+                  UI.error("Something Error with Slack Configuration : [Failed Send First Task Message]")
+                  puts error.backtrace
+               end
+        end
+
+        # 2. List All Available AVD's in The Device
+        # 3. Run the Target AVD Name From Params
+        if params[:avd_name].to_s.length > 0
+            Thread.new do
+               UI.message("Android Reporting Started to Run AVD : (" + avd_name + ")")
+               sh(android_sdk_path + "/tools/bin/avdmanager", "list", "avd")
+               sh("cd", android_sdk_path)
+               sh(android_sdk_path + "/emulator/emulator", "-avd", avd_name)
+            end
+        end
+
+        # 4. Clear the Logcat Server Before Start
+        if params[:generate_adb_file]
+            Process.fork do
+               sh("adb logcat -c")
+            end
+        end
+
+        # 5. Start Clean Task with Target UI Task
+        # 6. If Gradle Task Success then Will Generate ADB Log File then Kill Server Connection inside ADB
+        begin
+          UI.message([
+               "Android Reporting Started to Run Gradle Testing Task ...",
+               "Gradle Tasks : [Clean , Build , " + gradle_task_testing_name + "]"
+          ])
+          if params[:gradle_task_testing_name].to_s.length > 0
+              sh("./gradlew clean")
+              gradle_task_result = sh("./gradlew " + gradle_task_testing_name)
+              if gradle_task_result
+                  UI.message("Gradle Task Finished Successfully ...")
+                  if params[:generate_adb_file]
+                      Process.fork do
+                          UI.message([
+                            "Android Reporter Started to Save Logcat Logs From ADB Connection Server",
+                            "ADB Reporting File : [logcat.txt]"
+                          ])
+                          sh("adb logcat -d > logcat.txt kill-server")
+                      end
+                  end
+              end
+        end
+        rescue
+          UI.error("Gradle Task Finished With Error ...")
+          if params[:generate_adb_file]
+               Process.fork do
+                   sh("adb logcat -e > logcat.txt kill-server")
+               end
+          end
+        end
+
+        # 7. Generate Gradle Tasks (Failed and Success Files)
+        if params[:generate_gradle_files]
+             Process.fork do
+                sh("./gradlew build > android-logs.txt 2> android-error-logs.txt")
+                UI.message([
+                    "Android Reporting Started to Generate Gradle Reports Files",
+                    "Gradle Success Debug File : android-logs.txt",
+                    "Gradle Failed Debug File : android-error-logs.txt"
+                ])
+             end
+        end
+
+        # 8. Check Slack Option if Enabled or Not To Print The Message
+        if is_slack_enabled
+            UI.message("Slack Configuration Status : Started ...")
+        else
+            UI.message("Slack Configuration Status : Disabled ...")
+        end
+
+        # 9. Upload Files to Slack
+        if is_slack_enabled
+            begin
+              UI.message("Slack Messages Bot Upload Files Tasks Started ....")
+              if(File.exist?("logcat.txt"))
+                 UI.message("logcat.txt File exists ...")
+                 client.files_upload(
+                    channels: "#" + params[:slack_channel_name],
+                    as_user: true,
+                    file: Faraday::UploadIO.new('logcat.txt', 'text/plain'),
+                    title: "Android UI Testing (ADB Logcat Result)",
+                    filename: "logcat.txt",
+                    initial_comment: "Current UI Testing Build Result File Report [logcat.txt]"
+                 )
+
+                 isLogcatFileUploaded = true
+                 UI.message("Slack Step Upload [logcat.txt]")
+              else
+                 isLogcatFileUploaded = false
+                 UI.error("File does not exist [logcat.txt]")
+              end
+            rescue => error
+              if error
+                 UI.error("Something Error with Slack Upload File : [Step Upload Logcat.txt File to Slack]")
+              end
+                 puts error.message
+                 puts error.backtrace
+            end
+
+            begin
+              if(File.exist?("android-logs.txt"))
+                 UI.message("android-logs.txt File exists ...")
+                 client.files_upload(
+                      channels: "#" + params[:slack_channel_name],
+                      as_user: true,
+                      file: Faraday::UploadIO.new('android-logs.txt', 'text/plain'),
+                      title: "Android UI Testing (Gradle Debug File Result)",
+                      filename: "android-logs.txt",
+                      initial_comment: "Current UI Testing Build Result File Report [Gradle Debug Result]"
+                 )
+
+                 isGradleDebugFileUploaded = true
+                 UI.message("Slack Step Upload [android-logs.txt]")
+              else
+                 isGradleDebugFileUploaded = false
+                 UI.error("File does not exist [android-logs.txt]")
+              end
+            rescue => error
+                 if error
+                     UI.error("Something Error with Slack Upload File : [Step Upload Logcat.txt File to Slack]")
+                 end
+                     puts error.message
+                     puts error.backtrace
+            end
+
+            begin
+              if(File.exist?("android-error-logs.txt"))
+                 UI.message("android-error-logs.txt File exists ...")
+                 client.files_upload(
+                       channels: "#" + params[:slack_channel_name],
+                       as_user: true,
+                       file: Faraday::UploadIO.new('android-error-logs.txt', 'text/plain'),
+                       title: "Android UI Testing (Gradle Error File Result)",
+                       filename: "android-error-logs.txt",
+                       initial_comment: "Current UI Testing Build Result File Report [Gradle Error Result]"
+                 )
+
+                 isGradleErrorFileUploaded = true
+                 UI.message("Slack Step Upload [android-error-logs.txt]")
+              else
+                 isGradleErrorFileUploaded = false
+                 UI.error("File does not exist [android-error-logs.txt]")
+              end
+            rescue => error
+              if error
+                UI.error("Something Error with Slack Upload File : [Step Upload Logcat.txt File to Slack]")
+              end
+              puts error.message
+              puts error.backtrace
+            end
+
+            slackFinalMessageContent = "Files Status : With Time : " + time + " : Info = \n"
+            if isGradleDebugFileUploaded
+                slackFinalMessageContent += "Gradle Debug File Uploaded \n"
+            end
+
+            if isGradleErrorFileUploaded
+                slackFinalMessageContent += "Gradle Error File Uploaded \n"
+            end
+
+            if isLogcatFileUploaded
+                slackFinalMessageContent += "Logcat ADB Logging File Uploaded \n"
+            end
+
+            client.chat_postMessage(channel: "#" + params[:slack_channel_name], text: slackFinalMessageContent, as_user: true)
+        end
+
+      end
+
+      def self.description
+        "Open Android Emulators Then Generate Report File From Tests then Upload the File To Slack"
+      end
+
+      def self.authors
+        ["Yazan Tarifi"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "This Plugin Will Run Android Emulators from a List of Avd Names then Generate Gradle, Tests Report Files and Upload Them To Slack Channel"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+              key: :avd_name,
+              env_name: "ANDROID_REPORTER_AVD_NAME",
+              description: "Add Android Emulator Name to Start it before Execute the Commands",
+              optional: true,
+              type: String,
+              sensitive: true
+          ),
+          FastlaneCore::ConfigItem.new(
+              key: :android_sdk_path,
+              env_name: "ANDROID_REPORTER_ANDROID_SDK",
+              description: "Add Android SDK Full Path",
+              optional: true,
+              type: String,
+              sensitive: true
+          ),
+          FastlaneCore::ConfigItem.new(
+              key: :gradle_task_testing_name,
+              env_name: "ANDROID_TESTING_GRADLE_TASK",
+              description: "Add Android UI Testing Task Name",
+              optional: true,
+              type: String,
+              sensitive: true
+          ),
+          FastlaneCore::ConfigItem.new(
+              key: :generate_adb_file,
+              env_name: "ANDROID_REPORTER_ADB_REPORT FILE",
+              description: "This Option will Generate Adb Logcat Report File",
+              optional: true,
+              type: Boolean
+          ),
+          FastlaneCore::ConfigItem.new(
+              key: :generate_gradle_files,
+              env_name: "ANDROID_REPORTER_GRADLE_REPORT FILE",
+              description: "This Option will Generate Gradle Report File (Success File, Error File)",
+              optional: true,
+              type: Boolean
+          ),
+          FastlaneCore::ConfigItem.new(
+              key: :is_slack_upload_reports_enabled,
+              env_name: "ANDROID_REPORT_FILES_SLACK_UPLOAD_ENABLED",
+              description: "This Option will Check if Slack Upload Files Enabled or Not",
+              optional: true,
+              type: Boolean
+          ),
+          FastlaneCore::ConfigItem.new(
+              key: :slack_api_key,
+              env_name: "SLACK_API_TOKEN",
+              description: "Add Slack Api Key",
+              optional: true,
+              type: String,
+              sensitive: true
+          ),
+          FastlaneCore::ConfigItem.new(
+              key: :slack_channel_name,
+              env_name: "SLACK_CHANNEL_NAME",
+              description: "Add Slack Channel Name for Bot to Send Messages on this Channel",
+              optional: true,
+              type: String,
+              sensitive: true
+          ),
+          FastlaneCore::ConfigItem.new(
+              key: :tests_branch_name,
+              env_name: "TESTS_BRANCH_NAME",
+              description: "Add Branch TO Run Tests on Target Git Branch",
+              optional: true,
+              type: String,
+              sensitive: true
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        [:android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/android_reporter/helper/android_reporter_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class AndroidReporterHelper
+      # class methods that you define here become available in your action
+      # as `Helper::AndroidReporterHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the android_reporter plugin helper!")
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/android_reporter/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module AndroidReporter
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: android_reporter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yazan Tarifi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.176.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.176.0
+description:
+email: yazan.tarifi@opensooq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/android_reporter.rb
+- lib/fastlane/plugin/android_reporter/actions/android_reporter_action.rb
+- lib/fastlane/plugin/android_reporter/helper/android_reporter_helper.rb
+- lib/fastlane/plugin/android_reporter/version.rb
+homepage: https://github.com/Yazan98/android_reporter
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Open Android Emeulators Then Generate Report File From Tests then Upload
+  the File To Slack
+test_files: []