Merge pull request #1 from codescalersinternships/development

Psutils-golang

Author: xmonader

.github/workflows/main.yaml

@@ -0,0 +1,34 @@
+name: Go CI
+
+on:
+  push:
+
+jobs:
+  golangci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: stable
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: v1.60
+      - name: Go Format
+        uses: Jerome1337/gofmt-action@v1.0.5
+        with:
+          gofmt-path: './src'
+          gofmt-flags: '-l -d'
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: stable
+      - name: test
+        run: go test -v ./pkg
+
+

README.md

@@ -1 +1,59 @@
-# psutil-golang-RawanMostafa
+# Psutils
+
+This repository implements a human-friendly lib for querying processes, memory info and cpu info
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+
+
+## Installation
+
+Get the package
+
+   ```bash
+     go get github.com/codescalersinternships/psutil-golang-RawanMostafa
+   ```
+Import the package
+
+  ```go
+     import github.com/codescalersinternships/psutil-golang-RawanMostafa/pkg
+  ```
+
+## Usage
+
+  The psutils package offers different APIs like:
+
+### 1. CPU related APIs
+
+```go
+  cpuInfo, err := psutils.GetCpuInfo()
+    if err != nil {
+        //handle the error
+    }
+```
+
+### 2. Memory related APIs
+
+```go
+   memInfo, err := psutils.GetMemInfo()
+    if err != nil {
+        //handle the error
+    }
+```
+### 3. Processes related APIs
+
+1. ```go
+	procs, err := psutils.GetProcessList()
+    if err != nil {
+        //handle the error
+    }
+   ```
+
+2. ```go
+	procDetails, err := psutils.GetProcessDetails(1)
+    if err != nil {
+        //handle the error
+    }
+   ```

cmd/main.go

@@ -0,0 +1,22 @@
+package main
+
+import (
+	"log"
+
+	psutils "github.com/codescalersinternships/psutil-golang-RawanMostafa/pkg"
+)
+
+func main() {
+	cpuInfo, _ := psutils.GetCpuInfo()
+	log.Printf("%v", cpuInfo)
+	memInfo, err := psutils.GetMemInfo()
+	log.Printf("%v", memInfo)
+	log.Printf("err %v", err)
+	procs, err := psutils.GetProcessList()
+	log.Printf("%v\n", procs)
+	log.Printf("err %v", err)
+	det, err := psutils.GetProcessDetails(1)
+	log.Printf("%v\n", det)
+	log.Printf("err %v", err)
+
+}

go.mod

@@ -0,0 +1,11 @@
+module github.com/codescalersinternships/psutil-golang-RawanMostafa
+
+go 1.23.1
+
+require github.com/stretchr/testify v1.9.0
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -0,0 +1,9 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

pkg/cpuInfo.go

@@ -0,0 +1,84 @@
+// psutils package implements a human-friendly lib for querying processes, memory info and cpu info
+package psutils
+
+import (
+	"os"
+	"strconv"
+	"strings"
+)
+
+type Loader interface {
+	load(filePath string) (string, error)
+}
+
+type realCpuLoader struct{}
+
+func (l *realCpuLoader) load(filePath string) (string, error) {
+	return loadFile(filePath)
+}
+
+// CpuInfo holds some details about the CPU like number of cores, vendorID, model name, cache size, average CPU frequency
+type CpuInfo struct {
+	NumCores  int
+	VendorId  string
+	ModelName string
+	CacheSize string
+	CpuMHZ    float32
+}
+
+func loadFile(filepath string) (fileData string, err error) {
+	file, err := os.ReadFile(filepath)
+	fileData = string(file)
+
+	return
+}
+
+func setCpuInfo(cpuData string) (cpuInfo CpuInfo, err error) {
+	var processorsNum int
+	var totalFreq float32
+	lines := strings.SplitN(cpuData, "\n", -1)
+	for _, line := range lines {
+		if strings.HasPrefix(line, "processor") {
+			processorsNum++
+		} else if strings.HasPrefix(line, "vendor_id") {
+			parts := strings.Split(line, ":")
+			cpuInfo.VendorId = strings.TrimSpace(parts[1])
+
+		} else if strings.HasPrefix(line, "model name") {
+			parts := strings.Split(line, ":")
+			cpuInfo.ModelName = strings.TrimSpace(parts[1])
+
+		} else if strings.HasPrefix(line, "cache size") {
+			parts := strings.Split(line, ":")
+			cpuInfo.CacheSize = strings.TrimSpace(parts[1])
+
+		} else if strings.HasPrefix(line, "cpu MHz") {
+			parts := strings.Split(line, ":")
+			freq, err := strconv.ParseFloat(strings.TrimSpace(parts[1]), 32)
+
+			if err != nil {
+				return cpuInfo, err
+			}
+			totalFreq += float32(freq)
+		}
+	}
+	cpuInfo.NumCores = processorsNum
+	cpuInfo.CpuMHZ = totalFreq / float32(cpuInfo.NumCores)
+	return
+}
+
+// GetCpuInfo returns a CpuInfo type about the CPU in this moment
+func GetCpuInfo() (cpuInfo CpuInfo, err error) {
+	var _ Loader = (*realCpuLoader)(nil)
+	return getCpuInfo(&realCpuLoader{})
+}
+
+func getCpuInfo(loader Loader) (cpuInfo CpuInfo, err error) {
+
+	cpuData, err := loader.load("/proc/cpuinfo")
+	if err != nil {
+		return
+	}
+	cpuInfo, err = setCpuInfo(cpuData)
+	return
+}