initial commit

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# All files are owned by the maintainers
+* @eBayMobile/metrics-for-develocity-plugin-team

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: gradle
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/issue_template.md

@@ -0,0 +1,10 @@
+### Describe the Issue
+
+
+### Expected Behavior
+
+
+### Actual Behavior
+
+
+### Steps to Reproduce the Behavior

.github/pull_request_template.md

@@ -0,0 +1,4 @@
+This PR relates to Issue #
+
+Changes proposed in this pull request:
+- 

.github/workflows/precommit.yml

@@ -0,0 +1,15 @@
+name: PR Build
+on: [push]
+jobs:
+  gradle:
+    runs-on: ebaymobile
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-java@v3
+        with:
+          distribution: temurin
+          java-version: 17
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+      - name: Build Plugin
+        run: ./gradlew build

.gitignore

@@ -0,0 +1,12 @@
+.DS_Store
+.gradle
+.kotlin
+build
+
+# Android Studio / IntelliJ
+/.idea/*
+!/.idea/codeStyles
+!/.idea/runConfigurations/
+*.iws
+*.iml
+/local.properties

CODE_OF_CONDUCT.md

@@ -0,0 +1,4 @@
+# Code of Conduct
+
+Contributors to this project are expected to adhere to the
+[eBay Code of Conduct](https://github.com/eBay/.github/blob/main/CODE_OF_CONDUCT.md)

CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing to the Metrics for Develocity Plugin
+
+First, thank you for considering contributing to this project!
+
+We welcome contributions and have provided a guide to help make this is as straightforward as
+possible.
+
+## Steps
+
+1. [Raise an Issue](#raise-an-issue)
+1. [Write code](#write-code)
+1. [Submit pull request](#submit-pull-request)
+
+## Raise an Issue
+
+Before starting development please look at the existing issues to ensure that your concern or
+improvement  is not already being addressed.  This is important to prevent conflicting work.
+
+If no issues already match your intentions raise an issue with sufficient detail as to what you
+intend to do.  The issue can then become a place where discussion relating to the problem
+statement and intended approach can be had.
+
+This step is critical in ensuring that owners are aware of and can provide feedback on incoming
+changes.
+
+This helps eliminate duplicate work, conflicting work, or any other unintended consequences.
+
+## Write code
+
+All code should conform to the project's code style.  This project follows the
+[Kotlin Coding Conventions](https://kotlinlang.org/docs/coding-conventions.html).
+
+All work intended for release should be committed against the `main` branch.
+
+Work will not be considered complete unless it is in a publishable, production-ready
+state.  This restriction is in place to ensure that the library can be published when
+needed without delay.
+
+### Tests
+
+Every bug fix or change should be accompanied by corresponding tests.  These tests are
+important both to protect the quality of the library as well as to demonstrate scenarios
+that the change impacts.
+
+## Submit pull request
+
+Submit a PR  to merge the code into the `main` branch and assign to one or more
+owners for review.
+
+The PR should reference the issue being worked on and contain a description that is
+useful for understanding the implementation details.
+
+Once a PR is approved, it will likely be merged to `main`.
+
+If your change is time-sensitive, please indicate this fact in a comment on the
+PR.  The project owners will do their best to publish a release containing your change
+as soon as possible.
+

LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2017 eBay, Inc.
+
+   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.

README.md

@@ -0,0 +1,70 @@
+# Metrics for Develocity Plugin
+
+## Design Overview
+
+The data processing pipeline is split into two main elements:
+- Data gathering and aggregation
+- Data consumption / reporting
+
+### Data gathering tasks:
+
+The purpose of the data gathering tasks is to collect data from the Develocity API and
+aggregate it into summaries that can be used for reporting.  The data for this stage must be
+defined such that it can be accumulated over time through a reduction operation, adding the
+results of one build to the results of the next, etc..  The data collected in this stage can
+be thought of as an intermediate format, not intended for direct consumption.
+
+Multiple summaries can be created as a result of this stage of processing.  Summarizers are
+registered with the plugin and have the responsibility of processing the raw build data
+and producing the intermediate data format.
+
+Hourly tasks
+- Query the Develocity server for list of builds within the hour
+- For each configured summarizer:
+  - Process each build and produce a summary file
+  - reduces the summaries together, persisting them to disk by ID
+
+Daily tasks
+  - Depends upon the outputs of hourly tasks for the configured day
+  - For each configured summarizer:
+    - Loads the hourly summary files 
+    - reduces the summaries together, persisting them to disk by ID 
+
+Time window tasks (e.g., last 7 days)
+- Depends upon the outputs of hourly and/or daily tasks to satisfy the requested time window
+- For each configured summarizer:
+  - Loads the hourly summary files
+  - reduces the summaries together, persisting them to disk by ID
+
+### Data consumer/reporting tasks
+
+Data consumer / reporting tasks are configured to consume the aggregated data from the first
+stage of the pipeline and produce data or reports in their final form.  These tasks are
+to be implemented as needed to satisfy the requirements of the project.
+
+## Operation
+
+### Obtain / Configure a Develocity Access Token
+
+- `./gradlew provisionDevelocityAccessKey` or `./gradlew provisionGradleEnterpriseAccessKey`
+
+## Reference:
+
+### Gradle Enterprise API
+
+API Manual: https://docs.gradle.com/enterprise/api-manual/
+API Documentation: https://docs.gradle.com/enterprise/api-manual/ref/2022.4.html
+
+### OpenAPI
+
+This project uses the OpenAPI 3.0 specification. Both iOS and Android are using the
+[OpenAPI generator](https://github.com/OpenAPITools/openapi-generator) to output models. On the Android side,
+we're using [OpenAPI Gradle Plugin](https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator-gradle-plugin) --
+which is described below.
+
+The current specification, as defined by Gradle Enterprise, can be found
+[here](https://docs.gradle.com/enterprise/api-manual/#reference_documentation).
+
+## License
+
+Apache 2.0 - See [LICENSE](LICENSE.txt) for more information.