โปรแกรม CI ทำ upload ไฟล์ระบบจาก gitlab ไปยังตัว server demo ด้วยภาษา Python

 

 

สำหรับนักพัฒนาซอฟต์แวร์ คงจะเคยได้คำว่า GitLab หรือตัวเก็บซอร์สโค้ดที่เราได้พัฒนาขึ้นมาเก็บไว้บน Cloud เพื่อที่จะให้เพื่อนรวมงานสามารถพัฒนาต่อจากเราได้ เพื่อความสะดวก รวดเร็ว รวมไปถึงช่วยลดขั้นตอนการทำงานของทีม ตัวโปรแกรม upload ไฟล์ระบบจาก gitlab ไปยังตัว server demo ตัวนี้สามารถช่วยได้ในระดับนึ่ง ความรู้ที่ควรศึกษาก่อนนั้นจะเป็น python API เป็นส่วนใหญ่ และพวก ภาษา python พื้นฐาน เป็นต้น

อันดับแรกจะต้องมี user ของ gitlab และทำการขอ Personal Access Tokens จาก gitlab เพื่อทำการใช้ตัว API 

ขั้นตอนสามารถดูได้จากที่นี่ คลิก

เมื่อทำการขอ Personal Access Tokens เรียบร้อยแล้วให้ทำการสร้าง Project ใน pychram ขึ้นมา แล้วสร้างไฟล์ Python

จากนั้นทำการสร้างไฟล์ txt -ขึ้นมาใช้ชื่อว่า requirements.txt ให้พิมพ์คำสั่งตามนี้

requests==2.23.0
Flask==1.1.1
passlib==1.6.5
configparser==4.0.2

จากนั้นไปที่ terminal ของ pycharm พิมพ์คำสั่ง command ตามนี้เพื่อติดตั้ง library ของ python

pip install -r requirements.txt

เมื่อติตตั้งเสร็จแล้วทำการ import library เข้ามาใช้งานในไฟล์ Python ที่สร้างไว้ตอนแรก

from flask import Flask, render_template
from zipfile import ZipFile, BadZipfile

import requests, os, io, configparser, shutil

ให้ทำการสร้างไฟล์ config ขึ้นมาโดยสกุลไฟล์จะเป็น .conf จากนั้นพิมพ์คำสั่งตานนี้

[app_run]
host = < hostname >
port = < port >
debug = True

[gitlab]
git_url = < link gitlab >
private_token = < access token >
projectID_pathdemo = { < project ID >  : '< path demo >', < project ID >  : '< path demo >', < project ID >  : ['< path demo1 >', '< path demo2 >/']}

< hostname > คือ hostname ที่ติดตั้งโปรแกรม
< port > คือ port ที่ใช้
< link gitlab > คือ link gitlab ที่ใช้
< access token > คือ access token ที่ขอมาจาก gitlab
< project ID > คือ ID ของ project บน gitlab ที่ใช้
< path extension > คือ path ที่เก็บ extension บน server demo
< path demo > คือ path ของ server demo

ตัวอย่าง เช่น

[app_run]
host = 127.0.0.1
port = 5014
debug = True

[gitlab]
git_url = https://gitlab.com
private_token = Fg4ANg8jmwoH4vGHJfwi
projectID_pathdemo = { 254 : 'TEST_htmltopdf/', 38 : 'TEST_selenium/', 232 : ['TEST_htmltopdf/selenium_PHPBB/', 'TEST_selenium/selenium_PHPBB/']}

จากนั้นในไฟล์ python ให้ทำการ เพิ่มคำสั่งนี้เข้าไปเพื่อทำการเรียกใช้ไฟล์ config

config = configparser.ConfigParser()
config.read('tool_config.conf')

# ----app.run----
host = config['app_run']['host']
port = config['app_run']['port']
debug_run = config['app_run']['debug']

# ----gitlab----
git_url = config['gitlab']['git_url']
private_token = config['gitlab']['private_token']
id_pathdemo = config['gitlab']['projectID_pathdemo']

เขียนคำสั่งสร้างโฟรเดอร์เพื่อมาเก็บไฟล์ที่ดาวน์โหลดมาจาก gitlab

app = Flask(__name__)

if os.path.isdir('tmp_project') == False:
    os.mkdir('tmp_project')
    print "Directory tmp_project created successfully"
if os.path.isdir('tmp_zip') == False:
    os.mkdir('tmp_zip')
    print "Directory tmp_project created successfully"

จากนั้นทำการสร้าง method zip_dir จะทำการ extract ไฟล์ตาม projectที่เลือก

def zip_dir(directory, zipname, path_demo_project):
   if os.path.exists(directory):
      outZipFile = ZipFile(zipname, 'w')

      # The root directory within the ZIP file.
      rootdir = os.path.basename(directory)
      for dirpath, dirnames, filenames in os.walk(directory):
         for filename in filenames:
            filepath = os.path.join(dirpath, filename)
            parentpath = os.path.relpath(filepath, directory)
            arcname = os.path.join(rootdir, parentpath)
            outZipFile.write(filepath, arcname)

   outZipFile.close()
   try:
      with ZipFile(zipname, 'r') as zipObj:
         if type(path_demo_project) == list and len(path_demo_project) >1:
            for path in path_demo_project:
               zipObj.extractall(path)
         elif type(path_demo_project) == list and len(path_demo_project) == 1:
            zipObj.extractall(path_demo_project[0])
         else:
            zipObj.extractall(path_demo_project)
      zipObj.close()

      directory = directory.split("/")
      del directory[-1]
      directory = "/".join(directory)

      remove_directory = shutil.rmtree(directory)
      remove_zipname = os.remove(zipname)
      if remove_zipname == None and remove_directory == None:
         print 'remove tmp_zip & tmp_project success'
      return 'extract success'

   except (IOError, BadZipfile) as e:
      return e

ส่วน method ตัวนี้จะทำ request เพื่อที่จะขอไฟล์ระบบจาก gitlab โดยใช้ link API ของ gitlab

def request_url(id_project, path_project):
   url = git_url + '/api/v4/projects/' + str(id_project) + '/repository/archive.zip?private_token=' + private_token
   re = requests.get(url)
   z = ZipFile(io.BytesIO(re.content))
   z.extractall('tmp_project')
   pathname = z.namelist()[0]
   pathname = 'tmp_project/' + pathname

   return zip_dir(pathname, 'tmp_zip/project.zip', path_project)

คำสั่งอันนี้จะคำสั่งที่ให้ทุกส่วนทำงานตามลำดับ

@app.route('/<int:post_id>')
def index(post_id):
   id_path_dict = eval(id_pathdemo)
   if post_id in id_path_dict.keys():
      path_project = id_path_dict[post_id]
      id_project = post_id
      return request_url(id_project, path_project)
   else:
      return 'No Project ID in id_path, Chack your tool_config.conf'

โค้ดรวม

เมื่อทำทุกอย่างเสร็จแล้วทำการรันโปรแกรม จากนั้นไปใช้คำสั่ง command บน terminal

curl http://127.0.0.1:5014/<Project ID>

ตัวอย่างเช่น

curl http://127.0.0.1:5014/254

ผลจะได้ตามนี้