Differential D5584 Diff 14675 plugins/docker/dockerruntime.h

Changeset View

Standalone View

plugins/docker/dockerruntime.h

This file was added.

1		/*
2		Copyright 2017 Aleix Pol Gonzalez <aleixpol@kde.org>
3
4		This library is free software; you can redistribute it and/or
5		modify it under the terms of the GNU Library General Public
6		License version 2 as published by the Free Software Foundation.
7
8		This library is distributed in the hope that it will be useful,
9		but WITHOUT ANY WARRANTY; without even the implied warranty of
10		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11		Library General Public License for more details.
12
13		You should have received a copy of the GNU Library General Public License
14		along with this library; see the file COPYING.LIB. If not, write to
15		the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
16		Boston, MA 02110-1301, USA.
17		*/
18
19		#ifndef DOCKERRUNTIME_H
20		#define DOCKERRUNTIME_H
21
22		#include <interfaces/iruntime.h>
23		#include <util/path.h>
24		#include <QAction>
25
26		class KJob;
27		class DockerPreferencesSettings;
28
29		class DockerRuntime : public KDevelop::IRuntime
30		{
	mwolffUnsubmitted Done I think having a good apidox here is crucial so that others understand what this is doing. i.e. some short explanation of the concepts to get the path mapping etc. mwolff: I think having a good apidox here is crucial so that others understand what this is doing. i.e.
31		Q_OBJECT
32		public:
33		DockerRuntime(const QString& tag);
34		~DockerRuntime() override;
35
36		/**
37		* @returns the docker tagname as a text identifier
38		*/
39		QString name() const override { return m_tag; }
40
41		/**
42		* if @p enabled
43		* Mounts the docker image's file system into a subdirectory the user can read.
44		* if not @p enabled, it unmounts the image file system
45		*
46		* See GraphDriver.Data.UpperDir value in docker image inspect imagename
47		*
48		* Both require root privileges for now
49		*/
50		void setEnabled(bool enabled) override;
51
52		/**
53		* Call processes using "docker run..." passing on the proper environment and volumes
54		*
55		* Volumes will include source and build directories that need to be exposed
56		* into the container.
57		*/
58		void startProcess(KProcess *process) const override;
59		void startProcess(QProcess *process) const override;
60
61		/**
62		* Translates @p runtimePath from within the image into the host
63		*
64		* Takes into account the mounted upperDir and the different volumes set up
65		*/
66		KDevelop::Path pathInHost(const KDevelop::Path & runtimePath) const override;
67
68		/**
69		* Translates @p localPath into a path that can be accessed by the runtime
70		*/
71		KDevelop::Path pathInRuntime(const KDevelop::Path & localPath) const override;
72
73		/**
74		* @returns the environment variable with @p varname set by the recipe (usually the Dockerfile)
75		*/
76		QByteArray getenv(const QByteArray & varname) const override;
77
78		static DockerPreferencesSettings* s_settings;
79
80		private:
81		void inspectImage();
82		QStringList workingDirArgs(QProcess* process) const;
83
84		const QString m_tag;
85		QHash<QByteArray,QByteArray> m_envs;
86		KDevelop::Path m_upperDir;
87		KDevelop::Path m_userUpperDir;
88		};
89
90		#endif