diff options
author | Alexander Foremny <aforemny@posteo.de> | 2024-02-20 04:05:43 +0100 |
---|---|---|
committer | Alexander Foremny <aforemny@posteo.de> | 2024-02-20 08:00:58 +0100 |
commit | 8a2d06011a1b74c17963b2715b11d0ca7ba202a8 (patch) | |
tree | 547e894a2f8e58527f6a85b8d070a34a1b2ddcf4 |
init
-rw-r--r-- | .envrc | 1 | ||||
-rw-r--r-- | .gitignore | 2 | ||||
-rw-r--r-- | CHANGELOG.md | 5 | ||||
-rw-r--r-- | LICENSE | 202 | ||||
-rw-r--r-- | README.md | 11 | ||||
-rw-r--r-- | abuilder.cabal | 33 | ||||
-rw-r--r-- | abuilder.nix | 2 | ||||
-rw-r--r-- | app/Main.hs | 261 | ||||
-rw-r--r-- | default.nix | 21 | ||||
-rw-r--r-- | shell.nix | 1 |
10 files changed, 539 insertions, 0 deletions
@@ -0,0 +1 @@ +use nix diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6a91ac4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/dist-newstyle +/state diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..5566227 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Revision history for abuilder + +## 0.1.0.0 -- YYYY-mm-dd + +* First version. Released on an unsuspecting world. @@ -0,0 +1,202 @@ + + 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 [yyyy] [name of copyright owner] + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..bc997fc --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# abuilder + +simple build daemon + +## usage + +```console +export ABUILDER_STATE=./state +export ABUILDER_URLS=$HOME/src/foo:$HOME/src/bar +cabal run abuilder +``` diff --git a/abuilder.cabal b/abuilder.cabal new file mode 100644 index 0000000..fae0635 --- /dev/null +++ b/abuilder.cabal @@ -0,0 +1,33 @@ +cabal-version: 3.4 +name: abuilder +version: 0.1.0.0 +license: Apache-2.0 +license-file: LICENSE +maintainer: aforemny@posteo.de +author: Alexander Foremny +build-type: Simple +extra-doc-files: CHANGELOG.md + +executable abuilder + main-is: Main.hs + hs-source-dirs: app + default-language: GHC2021 + ghc-options: -Wall -threaded + build-depends: + base, + bytestring, + containers, + directory, + filepath, + gitlib, + gitlib-libgit2, + hinotify, + mtl, + split, + stm, + string-interpolate, + tagged, + temporary, + text, + typed-process, + utf8-string diff --git a/abuilder.nix b/abuilder.nix new file mode 100644 index 0000000..7942680 --- /dev/null +++ b/abuilder.nix @@ -0,0 +1,2 @@ +{ haskellPackages }: +haskellPackages.callCabal2nix "abuilder" ./. { } diff --git a/app/Main.hs b/app/Main.hs new file mode 100644 index 0000000..4765405 --- /dev/null +++ b/app/Main.hs @@ -0,0 +1,261 @@ +{-# LANGUAGE BlockArguments #-} +{-# LANGUAGE OverloadedRecordDot #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE QuasiQuotes #-} +{-# LANGUAGE ViewPatterns #-} +{-# LANGUAGE NoFieldSelectors #-} +{-# OPTIONS_GHC -fno-warn-name-shadowing #-} + +module Main where + +import Control.Concurrent +import Control.Concurrent.STM +import Control.Exception +import Control.Monad +import Data.ByteString.Lazy qualified as LB +import Data.ByteString.Lazy.UTF8 qualified as LB +import Data.ByteString.UTF8 qualified as B +import Data.List.Split +import Data.Map.Merge.Strict qualified as M +import Data.Map.Strict qualified as M +import Data.Maybe +import Data.String.Interpolate (i) +import Data.Tagged +import Data.Text qualified as T +import Git +import Git.Libgit2 +import System.Directory +import System.Environment +import System.FilePath +import System.INotify +import System.IO +import System.IO.Temp +import System.IO.Unsafe +import System.Process.Typed +import Text.Printf + +stateDirectory :: FilePath +stateDirectory = unsafePerformIO (getEnv "ABUILDER_STATE") + +ref :: String +ref = fromMaybe "main" (unsafePerformIO (lookupEnv "ABUILDER_BRANCH")) + +type JobName = String + +type Url = FilePath + +urls :: M.Map JobName Url +urls = + M.fromList . map ((,) <$> takeBaseName <*> id) $ + splitOn ":" (unsafePerformIO (getEnv "ABUILDER_URLS")) + +concurrentBuilders :: Int +concurrentBuilders = 2 + +type DesiredOutputs = M.Map JobName CommitHash + +type CommitHash = String + +type ActualOutputs = M.Map JobName CommitHash + +data BuildJobs = BuildJobs + { pendingBuilds :: M.Map JobName CommitHash, + runningBuilds :: M.Map JobName CommitHash + } + deriving (Show) + +diff :: DesiredOutputs -> ActualOutputs -> BuildJobs +diff desiredOutputs actualOutputs = + BuildJobs + { pendingBuilds = + M.merge + M.preserveMissing + M.dropMissing + ( M.zipWithMaybeMatched + ( \_ actualCommit desiredCommit -> + if desiredCommit /= actualCommit + then Just desiredCommit + else Nothing + ) + ) + desiredOutputs + actualOutputs, + runningBuilds = M.empty + } + +replaceBuildJobs :: BuildJobs -> BuildJobs -> BuildJobs +replaceBuildJobs oldBuildJobs newBuildJobs = + BuildJobs + { pendingBuilds = + M.differenceWithKey + ( \_ pendingCommit runningCommit -> + if pendingCommit /= runningCommit + then Just pendingCommit + else Nothing + ) + newBuildJobs.pendingBuilds + oldBuildJobs.runningBuilds, + runningBuilds = oldBuildJobs.runningBuilds + } + +data BuildJob = BuildJob + { jobName :: JobName, + commitHash :: CommitHash + } + deriving (Show) + +obtainBuildJob :: BuildJobs -> (Maybe BuildJob, BuildJobs) +obtainBuildJob buildJobs = do + case uncurry BuildJob <$> M.lookupMin buildJobs.pendingBuilds of + Just buildJob@(BuildJob {jobName, commitHash}) -> + ( Just buildJob, + buildJobs + { pendingBuilds = M.delete jobName buildJobs.pendingBuilds, + runningBuilds = M.insert jobName commitHash buildJobs.runningBuilds + } + ) + Nothing -> + (Nothing, buildJobs) + +completeBuildJob :: BuildJob -> BuildJobs -> BuildJobs +completeBuildJob (BuildJob {jobName, commitHash}) buildJobs = + buildJobs + { runningBuilds = + M.filterWithKey + ( \jobName' commitHash' -> + jobName' /= jobName || commitHash' /= commitHash + ) + buildJobs.runningBuilds + } + +data Builder = Builder Int + deriving (Show) + +data LogEntry = BuildEntry + { builder :: Builder, + buildJob :: BuildJob, + payload :: LB.ByteString + } + deriving (Show) + +main :: IO () +main = do + hSetBuffering stderr LineBuffering + hSetBuffering stdout LineBuffering + inotify <- initINotify + desiredOutputsT <- newTVarIO M.empty + actualOutputsT <- newTVarIO M.empty + buildJobsT <- newTVarIO (BuildJobs M.empty M.empty) + logs <- newTQueueIO + createDirectoryIfMissing True stateDirectory + setCurrentDirectory stateDirectory + mapM_ + (forkIO . builder logs buildJobsT) + (map Builder [1 .. concurrentBuilders]) + mapM_ (uncurry (watch inotify desiredOutputsT)) (M.toList urls) + _ <- forkIO (scheduler desiredOutputsT actualOutputsT buildJobsT) + forever do + log <- atomically $ readTQueue logs + case log of + BuildEntry _ (BuildJob {jobName}) (LB.toString -> payload) -> + printf "[%s] %s\n" jobName payload + +scheduler :: + TVar DesiredOutputs -> + TVar ActualOutputs -> + TVar BuildJobs -> + IO () +scheduler desiredOutputsT actualOutputsT buildJobsT = do + lastDesiredOutputsT <- newTVarIO Nothing + forever $ atomically do + lastDesiredOutputs <- readTVar lastDesiredOutputsT + desiredOutputs <- readTVar desiredOutputsT + check (Just desiredOutputs /= lastDesiredOutputs) + actualOutputs <- readTVar actualOutputsT + let buildJobs' = diff desiredOutputs actualOutputs + buildJobs <- readTVar buildJobsT + writeTVar buildJobsT (replaceBuildJobs buildJobs buildJobs') + writeTVar lastDesiredOutputsT (Just desiredOutputs) + +builder :: TQueue LogEntry -> TVar BuildJobs -> Builder -> IO () +builder logs buildJobsT builder = + forever + ( do + buildJob <- atomically do + buildJobs <- readTVar buildJobsT + let (maybeBuildJob, buildJobs') = obtainBuildJob buildJobs + check (isJust maybeBuildJob) + writeTVar buildJobsT buildJobs' + pure (fromJust maybeBuildJob) + + build logs builder buildJob + `catch` ( \(e :: SomeException) -> do + print e + ) + ) + +build :: TQueue LogEntry -> Builder -> BuildJob -> IO () +build logs builder buildJob@(BuildJob {jobName, commitHash}) = do + let url = urls M.! jobName + rev = commitHash + refDir = jobName </> ref + tmpDir = jobName <> "-" <> rev + exitCodeT <- newEmptyTMVarIO + _ <- + flip forkFinally (atomically . putTMVar exitCodeT) do + withSystemTempDirectory tmpDir $ \tmpDir -> do + writeFile (tmpDir </> "default.nix") $ + [i| + import + (fetchGit { + url = "#{url}"; + ref = "#{ref}"; + rev = "#{rev}"; + }) + |] + (LB.lines -> out) <- + readProcessInterleaved_ + (setWorkingDir tmpDir "nix-build .") + mapM_ + ( atomically + . writeTQueue logs + . BuildEntry builder buildJob + ) + out + getSymbolicLinkTarget (tmpDir </> "result") + exitCode <- atomically $ takeTMVar exitCodeT + case exitCode of + Left e -> throw e + Right nixDir -> do + createDirectoryIfMissing True jobName + _ <- try @SomeException (removeDirectoryLink refDir) + createDirectoryLink nixDir refDir + +watch :: INotify -> TVar DesiredOutputs -> JobName -> Url -> IO () +watch inotify desiredOutputsT jobName url = do + let bareFp = url </> "refs/heads" + nonBareFp = url </> ".git/refs/heads" + isBare <- doesDirectoryExist bareFp + _ <- addWatch + inotify + [ Modify, + MoveIn + ] + (B.fromString (if isBare then bareFp else nonBareFp)) + $ \e -> do + let isChange = + case e of + System.INotify.Modified _ (Just (B.toString -> filePath)) -> filePath == ref + System.INotify.MovedIn False (B.toString -> filePath) _ -> filePath == ref + _ -> False + when isChange do + updateDesiredOutputs + updateDesiredOutputs + where + updateDesiredOutputs = do + rev <- withRepository lgFactory url do + Just cid <- resolveReference ("refs/heads/" <> T.pack ref) + show . untag . (.commitOid) <$> lookupCommit (Tagged cid) + atomically do + desiredOutputs <- readTVar desiredOutputsT + writeTVar desiredOutputsT (M.insert jobName rev desiredOutputs) diff --git a/default.nix b/default.nix new file mode 100644 index 0000000..a602d13 --- /dev/null +++ b/default.nix @@ -0,0 +1,21 @@ +{ pkgs ? import <nixpkgs> { } }: +let + haskellPackages = pkgs.haskellPackages.override { + overrides = self: super: { + abuilder = self.callCabal2nix "abuilder" ./. { }; + }; + }; +in +rec { + inherit (haskellPackages) abuilder; + shell = haskellPackages.shellFor { + packages = _: [ abuilder ]; + buildInputs = [ + haskellPackages.cabal2nix + haskellPackages.cabal-install + haskellPackages.ormolu + ]; + withHoogle = true; + withHaddock = true; + }; +} diff --git a/shell.nix b/shell.nix new file mode 100644 index 0000000..a6bdf20 --- /dev/null +++ b/shell.nix @@ -0,0 +1 @@ +(import ./. { }).shell |